Interface CreateResourceSnapshotJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateResourceSnapshotJobRequest.Builder,
,CreateResourceSnapshotJobRequest> PartnerCentralSellingRequest.Builder
,SdkBuilder<CreateResourceSnapshotJobRequest.Builder,
,CreateResourceSnapshotJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateResourceSnapshotJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the catalog in which to create the snapshot job.clientToken
(String clientToken) A client-generated UUID used for idempotency check.engagementIdentifier
(String engagementIdentifier) Specifies the identifier of the engagement associated with the resource to be snapshotted.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceIdentifier
(String resourceIdentifier) Specifies the identifier of the specific resource to be snapshotted.resourceSnapshotTemplateIdentifier
(String resourceSnapshotTemplateIdentifier) Specifies the name of the template that defines the schema for the snapshot.resourceType
(String resourceType) The type of resource for which the snapshot job is being created.resourceType
(ResourceType resourceType) The type of resource for which the snapshot job is being created.tags
(Collection<Tag> tags) A map of the key-value pairs of the tag or tags to assign.tags
(Consumer<Tag.Builder>... tags) A map of the key-value pairs of the tag or tags to assign.A map of the key-value pairs of the tag or tags to assign.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
catalog
Specifies the catalog in which to create the snapshot job. Valid values are
AWS
andSandbox
.- Parameters:
catalog
- Specifies the catalog in which to create the snapshot job. Valid values areAWS
andSandbox
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.
- Parameters:
clientToken
- A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engagementIdentifier
Specifies the identifier of the engagement associated with the resource to be snapshotted.
- Parameters:
engagementIdentifier
- Specifies the identifier of the engagement associated with the resource to be snapshotted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceIdentifier
Specifies the identifier of the specific resource to be snapshotted. The format depends on the
ResourceType
.- Parameters:
resourceIdentifier
- Specifies the identifier of the specific resource to be snapshotted. The format depends on theResourceType
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceSnapshotTemplateIdentifier
CreateResourceSnapshotJobRequest.Builder resourceSnapshotTemplateIdentifier(String resourceSnapshotTemplateIdentifier) Specifies the name of the template that defines the schema for the snapshot.
- Parameters:
resourceSnapshotTemplateIdentifier
- Specifies the name of the template that defines the schema for the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceType
The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e.
Opportunity
- Parameters:
resourceType
- The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e.Opportunity
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceType
The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e.
Opportunity
- Parameters:
resourceType
- The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e.Opportunity
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
A map of the key-value pairs of the tag or tags to assign.
- Parameters:
tags
- A map of the key-value pairs of the tag or tags to assign.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A map of the key-value pairs of the tag or tags to assign.
- Parameters:
tags
- A map of the key-value pairs of the tag or tags to assign.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A map of the key-value pairs of the tag or tags to assign.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateResourceSnapshotJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateResourceSnapshotJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-