Class UpdatePackageVersionsStatusRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePackageVersionsStatusRequest.Builder,
UpdatePackageVersionsStatusRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
domain()
The name of the domain that contains the repository that contains the package versions with a status to be updated.final String
The 12-digit account number of the Amazon Web Services account that owns the domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final PackageVersionStatus
The package version’s expected status before it is updated.final String
The package version’s expected status before it is updated.final PackageFormat
format()
A format that specifies the type of the package with the statuses to update.final String
A format that specifies the type of the package with the statuses to update.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the VersionRevisions property.final boolean
For responses, this returns true if the service returned a value for the Versions property.final String
The namespace of the package version to be updated.final String
The name of the package with the version statuses to update.final String
The repository that contains the package versions with the status you want to update.static Class
<? extends UpdatePackageVersionsStatusRequest.Builder> final PackageVersionStatus
The status you want to change the package version status to.final String
The status you want to change the package version status to.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.A map of package versions and package version revisions.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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 returnPackageFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- A format that specifies the type of the package with the statuses to update.
- See Also:
-
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 returnPackageFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- A format that specifies the type of the package with the statuses to update.
- See Also:
-
namespace
The namespace of the package version to be updated. The package 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 or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
- Returns:
- The namespace of the package version to be updated. The package 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 or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
-
-
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 theisEmpty()
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
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 theisEmpty()
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
A map of package versions and package version revisions. The map
key
is the package version (for example,3.5.2
), and the mapvalue
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 mapvalue
is the package version revision.
-
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 timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
.If the service returns an enum value that is not available in the current SDK version,
expectedStatus
will returnPackageVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexpectedStatusAsString()
.- 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 timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
. - See Also:
-
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 timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
.If the service returns an enum value that is not available in the current SDK version,
expectedStatus
will returnPackageVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexpectedStatusAsString()
.- 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 timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
. - See Also:
-
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 returnPackageVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetStatusAsString()
.- Returns:
- The status you want to change the package version status to.
- See Also:
-
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 returnPackageVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetStatusAsString()
.- Returns:
- The status you want to change the package version status to.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdatePackageVersionsStatusRequest.Builder,
UpdatePackageVersionsStatusRequest> - Specified by:
toBuilder
in classCodeartifactRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdatePackageVersionsStatusRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-