Interface CreateResourceSnapshotJobRequest.Builder

  • Method Details

    • catalog

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

      Parameters:
      catalog - Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.
      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

      CreateResourceSnapshotJobRequest.Builder engagementIdentifier(String 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

      CreateResourceSnapshotJobRequest.Builder resourceIdentifier(String 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 the ResourceType.
      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 the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.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 interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.