software.amazon.awssdk.services.codeartifact.model

Class UpdatePackageVersionsStatusRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codeartifact.model.CodeartifactRequest

software.amazon.awssdk.services.codeartifact.model.UpdatePackageVersionsStatusRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePackageVersionsStatusRequest.Builder,UpdatePackageVersionsStatusRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdatePackageVersionsStatusRequest
extends CodeartifactRequest
implements ToCopyableBuilder<UpdatePackageVersionsStatusRequest.Builder,UpdatePackageVersionsStatusRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdatePackageVersionsStatusRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdatePackageVersionsStatusRequest.Builder	builder()
String	domain() The name of the domain that contains the repository that contains the package versions with a status to be updated.
String	domainOwner() The 12-digit account number of the Amazon Web Services account that owns the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PackageVersionStatus	expectedStatus() The package version’s expected status before it is updated.
String	expectedStatusAsString() The package version’s expected status before it is updated.
PackageFormat	format() A format that specifies the type of the package with the statuses to update.
String	formatAsString() A format that specifies the type of the package with the statuses to update.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVersionRevisions() For responses, this returns true if the service returned a value for the VersionRevisions property.
boolean	hasVersions() For responses, this returns true if the service returned a value for the Versions property.
String	namespace() The namespace of the package version to be updated.
String	packageValue() The name of the package with the version statuses to update.
String	repository() The repository that contains the package versions with the status you want to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdatePackageVersionsStatusRequest.Builder>	serializableBuilderClass()
PackageVersionStatus	targetStatus() The status you want to change the package version status to.
String	targetStatusAsString() The status you want to change the package version status to.
UpdatePackageVersionsStatusRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,String>	versionRevisions() A map of package versions and package version revisions.
List<String>	versions() An array of strings that specify the versions of the package with the statuses to update.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domain

public final String domain()

The name of the domain that contains the repository that contains the package versions with a status to be updated.

Returns:

The name of the domain that contains the repository that contains the package versions with a status to be updated.

domainOwner

public final String domainOwner()

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

repository

public final String repository()

The repository that contains the package versions with the status you want to update.

Returns:

The repository that contains the package versions with the status you want to update.

format

public final PackageFormat format()

A format that specifies the type of the package with the statuses to update.

If the service returns an enum value that is not available in the current SDK version, format will return PackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

A format that specifies the type of the package with the statuses to update.

See Also:

PackageFormat

formatAsString

public final String formatAsString()

A format that specifies the type of the package with the statuses to update.

If the service returns an enum value that is not available in the current SDK version, format will return PackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

A format that specifies the type of the package with the statuses to update.

See Also:

PackageFormat

namespace

public final String namespace()

The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm package version is its scope.

• Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

• The namespace of a generic package is its namespace.

Returns:

The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.

• The namespace of an npm package version is its scope.

• Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

• The namespace of a generic package is its namespace.

packageValue

public final String packageValue()

The name of the package with the version statuses to update.

Returns:

The name of the package with the version statuses to update.

hasVersions

public final boolean hasVersions()

For responses, this returns true if the service returned a value for the Versions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

versions

public final List<String> versions()

An array of strings that specify the versions of the package with the statuses to update.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVersions() method.

Returns:

An array of strings that specify the versions of the package with the statuses to update.

hasVersionRevisions

public final boolean hasVersionRevisions()

For responses, this returns true if the service returned a value for the VersionRevisions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

versionRevisions

public final Map<String,String> versionRevisions()

A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVersionRevisions() method.

Returns:

A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.

expectedStatus

public final PackageVersionStatus expectedStatus()

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

If the service returns an enum value that is not available in the current SDK version, expectedStatus will return PackageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expectedStatusAsString().

Returns:

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

See Also:

PackageVersionStatus

expectedStatusAsString

public final String expectedStatusAsString()

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

If the service returns an enum value that is not available in the current SDK version, expectedStatus will return PackageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expectedStatusAsString().

Returns:

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

See Also:

PackageVersionStatus

targetStatus

public final PackageVersionStatus targetStatus()

The status you want to change the package version status to.

If the service returns an enum value that is not available in the current SDK version, targetStatus will return PackageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetStatusAsString().

Returns:

The status you want to change the package version status to.

See Also:

PackageVersionStatus

targetStatusAsString

public final String targetStatusAsString()

The status you want to change the package version status to.

If the service returns an enum value that is not available in the current SDK version, targetStatus will return PackageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetStatusAsString().

Returns:

The status you want to change the package version status to.

See Also:

PackageVersionStatus

toBuilder

public UpdatePackageVersionsStatusRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePackageVersionsStatusRequest.Builder,UpdatePackageVersionsStatusRequest>

Specified by:

toBuilder in class CodeartifactRequest

builder

public static UpdatePackageVersionsStatusRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdatePackageVersionsStatusRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo