Class GetResourceSnapshotJobResponse

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

  • Method Details

    • catalog

      public final String catalog()

      The catalog in which the snapshot job was created. This will match the Catalog specified in the request.

      Returns:
      The catalog in which the snapshot job was created. This will match the Catalog specified in the request.

    • id

      public final String id()

      The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

      Returns:
      The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

      Returns:
      The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

    • engagementId

      public final String engagementId()

      The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

      Returns:
      The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

    • resourceType

      public final ResourceType resourceType()

      The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.

      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 being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.

      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 being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
      See Also:

    • resourceId

      public final String resourceId()

      The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.

      Returns:
      The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

      Returns:
      The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

    • resourceSnapshotTemplateName

      public final String resourceSnapshotTemplateName()

      The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

      Returns:
      The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

    • createdAt

      public final Instant createdAt()

      The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

      Returns:
      The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

    • status

      public final ResourceSnapshotJobStatus status()

      The current status of the snapshot job. Valid values:

      • STOPPED: The job is not currently running.

      • RUNNING: The job is actively executing.

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

      Returns:
      The current status of the snapshot job. Valid values:

      • STOPPED: The job is not currently running.

      • RUNNING: The job is actively executing.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the snapshot job. Valid values:

      • STOPPED: The job is not currently running.

      • RUNNING: The job is actively executing.

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

      Returns:
      The current status of the snapshot job. Valid values:

      • STOPPED: The job is not currently running.

      • RUNNING: The job is actively executing.

      See Also:

    • lastSuccessfulExecutionDate

      public final Instant lastSuccessfulExecutionDate()

      The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

      Returns:
      The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

    • lastFailure

      public final String lastFailure()

      If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

      Returns:
      If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

    • toBuilder

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

    • builder

      public static GetResourceSnapshotJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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