Package software.amazon.awssdk.services.partnercentralselling.model

Class GetResourceSnapshotRequest

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.GetResourceSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetResourceSnapshotRequest
extends PartnerCentralSellingRequest
implements ToCopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetResourceSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetResourceSnapshotRequest.Builder	builder()
String	catalog()	Specifies the catalog related to the request.
String	engagementIdentifier()	The unique identifier of the engagement associated with the snapshot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	resourceIdentifier()	The unique identifier of the specific resource that was snapshotted.
String	resourceSnapshotTemplateIdentifier()	he name of the template that defines the schema for the snapshot.
ResourceType	resourceType()	Specifies the type of resource that was snapshotted.
String	resourceTypeAsString()	Specifies the type of resource that was snapshotted.
Integer	revision()	Specifies which revision of the snapshot to retrieve.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetResourceSnapshotRequest.Builder>	serializableBuilderClass()
GetResourceSnapshotRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

catalog

public final String catalog()

Specifies the catalog related to the request. Valid values are:

• AWS: Retrieves the snapshot from the production AWS environment.

• Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.

Returns:

Specifies the catalog related to the request. Valid values are:

• AWS: Retrieves the snapshot from the production AWS environment.

• Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.

engagementIdentifier

public final String engagementIdentifier()

The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

Returns:

The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

resourceIdentifier

public final String resourceIdentifier()

The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

Returns:

The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

resourceSnapshotTemplateIdentifier

public final String resourceSnapshotTemplateIdentifier()

he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

Returns:

he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

resourceType

public final ResourceType resourceType()

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

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:

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

See Also:

ResourceType

resourceTypeAsString

public final String resourceTypeAsString()

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

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:

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

See Also:

ResourceType

revision

public final Integer revision()

Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

Returns:

Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

toBuilder

public GetResourceSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>

Specified by:

toBuilder in class PartnerCentralSellingRequest

builder

public static GetResourceSnapshotRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo