Class CreateResourceSnapshotJobRequest

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

  • Method Details

    • catalog

      public final String catalog()

      Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

      Returns:
      Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

    • clientToken

      public final String clientToken()

      A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

      Returns:
      A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

    • engagementIdentifier

      public final String engagementIdentifier()

      Specifies the identifier of the engagement associated with the resource to be snapshotted.

      Returns:
      Specifies the identifier of the engagement associated with the resource to be snapshotted.

    • resourceIdentifier

      public final String resourceIdentifier()

      Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

      Returns:
      Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

    • resourceSnapshotTemplateIdentifier

      public final String resourceSnapshotTemplateIdentifier()

      Specifies the name of the template that defines the schema for the snapshot.

      Returns:
      Specifies the name of the template that defines the schema for the snapshot.

    • resourceType

      public final ResourceType resourceType()

      The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

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

      Returns:
      The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

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

      Returns:
      The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity
      See Also:

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A map of the key-value pairs of the tag or tags to assign.

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

      Returns:
      A map of the key-value pairs of the tag or tags to assign.

    • toBuilder

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

    • builder

      public static CreateResourceSnapshotJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateResourceSnapshotJobRequest.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.