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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetResourceSnapshotJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the snapshot job.static GetResourceSnapshotJobResponse.Builderbuilder()Stringcatalog()The catalog in which the snapshot job was created.InstantcreatedAt()The date and time when the snapshot job was created in ISO 8601 format (UTC).StringengagementId()The identifier of the engagement associated with this snapshot job.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The unique identifier of the snapshot job.StringlastFailure()If the job has encountered any failures, this field contains the error message from the most recent failure.InstantlastSuccessfulExecutionDate()The date and time of the last successful execution of the job, in ISO 8601 format (UTC).StringresourceArn()The Amazon Resource Name (ARN) of the resource being snapshotted.StringresourceId()The identifier of the specific resource being snapshotted.StringresourceSnapshotTemplateName()The name of the template used for creating the snapshot.ResourceTyperesourceType()The type of resource being snapshotted.StringresourceTypeAsString()The type of resource being snapshotted.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetResourceSnapshotJobResponse.Builder>serializableBuilderClass()ResourceSnapshotJobStatusstatus()The current status of the snapshot job.StringstatusAsString()The current status of the snapshot job.GetResourceSnapshotJobResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
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.
-
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.
-
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"
-
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.
-
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.
-
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.
-
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"
-
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.
-
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.
-
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.
-
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,
resourceTypewill returnResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- 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:
ResourceType
-
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,
resourceTypewill returnResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- 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:
ResourceType
-
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,
statuswill returnResourceSnapshotJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
ResourceSnapshotJobStatus
-
-
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,
statuswill returnResourceSnapshotJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
ResourceSnapshotJobStatus
-
-
toBuilder
public GetResourceSnapshotJobResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetResourceSnapshotJobResponse.Builder,GetResourceSnapshotJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetResourceSnapshotJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetResourceSnapshotJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-