Class CopyProductRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest
software.amazon.awssdk.services.servicecatalog.model.CopyProductRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CopyProductRequest.Builder,CopyProductRequest>
@Generated("software.amazon.awssdk:codegen") public final class CopyProductRequest extends ServiceCatalogRequest implements ToCopyableBuilder<CopyProductRequest.Builder,CopyProductRequest>

  • Method Details

    • acceptLanguage

      public final String acceptLanguage()

      The language code.

      • jp - Japanese

      • zh - Chinese

      Returns:
      The language code.

      • jp - Japanese

      • zh - Chinese

    • sourceProductArn

      public final String sourceProductArn()

      The Amazon Resource Name (ARN) of the source product.

      Returns:
      The Amazon Resource Name (ARN) of the source product.

    • targetProductId

      public final String targetProductId()

      The identifier of the target product. By default, a new product is created.

      Returns:
      The identifier of the target product. By default, a new product is created.

    • targetProductName

      public final String targetProductName()

      A name for the target product. The default is the name of the source product.

      Returns:
      A name for the target product. The default is the name of the source product.

    • sourceProvisioningArtifactIdentifiers

      public final List<Map<ProvisioningArtifactPropertyName,String>> sourceProvisioningArtifactIdentifiers()

      The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

      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 hasSourceProvisioningArtifactIdentifiers() method.

      Returns:
      The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

    • hasSourceProvisioningArtifactIdentifiers

      public final boolean hasSourceProvisioningArtifactIdentifiers()
      For responses, this returns true if the service returned a value for the SourceProvisioningArtifactIdentifiers 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.

    • sourceProvisioningArtifactIdentifiersAsStrings

      public final List<Map<String,String>> sourceProvisioningArtifactIdentifiersAsStrings()

      The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

      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 hasSourceProvisioningArtifactIdentifiers() method.

      Returns:
      The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

    • copyOptions

      public final List<CopyOption> copyOptions()

      The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

      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 hasCopyOptions() method.

      Returns:
      The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

    • hasCopyOptions

      public final boolean hasCopyOptions()
      For responses, this returns true if the service returned a value for the CopyOptions 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.

    • copyOptionsAsStrings

      public final List<String> copyOptionsAsStrings()

      The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

      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 hasCopyOptions() method.

      Returns:
      The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

    • idempotencyToken

      public final String idempotencyToken()

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      Returns:
      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    • toBuilder

      public CopyProductRequest.Builder 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 interface ToCopyableBuilder<CopyProductRequest.Builder,CopyProductRequest>
      Specified by:
      toBuilder in class ServiceCatalogRequest
      Returns:
      a builder for type T

    • builder

      public static CopyProductRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CopyProductRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.