Class CreateLocationAzureBlobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datasync.model.DataSyncRequest
software.amazon.awssdk.services.datasync.model.CreateLocationAzureBlobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateLocationAzureBlobRequest.Builder,CreateLocationAzureBlobRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLocationAzureBlobRequest extends DataSyncRequest implements ToCopyableBuilder<CreateLocationAzureBlobRequest.Builder,CreateLocationAzureBlobRequest>

  • Method Details

    • containerUrl

      public final String containerUrl()

      Specifies the URL of the Azure Blob Storage container involved in your transfer.

      Returns:
      Specifies the URL of the Azure Blob Storage container involved in your transfer.

    • authenticationType

      public final AzureBlobAuthenticationType authenticationType()

      Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

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

      Returns:
      Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

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

      Returns:
      Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
      See Also:

    • sasConfiguration

      public final AzureBlobSasConfiguration sasConfiguration()

      Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

      If you provide an authentication token using SasConfiguration, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's secrets manager secret.

      Returns:
      Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

      If you provide an authentication token using SasConfiguration, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's secrets manager secret.

    • blobType

      public final AzureBlobType blobType()

      Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.

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

      Returns:
      Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.
      See Also:

    • blobTypeAsString

      public final String blobTypeAsString()

      Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.

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

      Returns:
      Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.
      See Also:

    • accessTier

      public final AzureAccessTier accessTier()

      Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.

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

      Returns:
      Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
      See Also:

    • accessTierAsString

      public final String accessTierAsString()

      Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.

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

      Returns:
      Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
      See Also:

    • subdirectory

      public final String subdirectory()

      Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

      Returns:
      Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

    • hasAgentArns

      public final boolean hasAgentArns()
      For responses, this returns true if the service returned a value for the AgentArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • agentArns

      public final List<String> agentArns()

      (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

      You can specify more than one agent. For more information, see Using multiple agents for your transfer.

      Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAgentArns() method.

      Returns:
      (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

      You can specify more than one agent. For more information, see Using multiple agents for your transfer.

      Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<TagListEntry> tags()

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

    • cmkSecretConfig

      public final CmkSecretConfig cmkSecretConfig()

      Specifies configuration information for a DataSync-managed secret, which includes the authentication token that DataSync uses to access a specific AzureBlob storage location, with a customer-managed KMS key.

      When you include this paramater as part of a CreateLocationAzureBlob request, you provide only the KMS key ARN. DataSync uses this KMS key together with the authentication token you specify for SasConfiguration to create a DataSync-managed secret to store the location access credentials.

      Make sure the DataSync has permission to access the KMS key that you specify.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      Returns:
      Specifies configuration information for a DataSync-managed secret, which includes the authentication token that DataSync uses to access a specific AzureBlob storage location, with a customer-managed KMS key.

      When you include this paramater as part of a CreateLocationAzureBlob request, you provide only the KMS key ARN. DataSync uses this KMS key together with the authentication token you specify for SasConfiguration to create a DataSync-managed secret to store the location access credentials.

      Make sure the DataSync has permission to access the KMS key that you specify.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

    • customSecretConfig

      public final CustomSecretConfig customSecretConfig()

      Specifies configuration information for a customer-managed Secrets Manager secret where the authentication token for an AzureBlob storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

      Returns:
      Specifies configuration information for a customer-managed Secrets Manager secret where the authentication token for an AzureBlob storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

      You can use either CmkSecretConfig (with SasConfiguration) or CustomSecretConfig (without SasConfiguration) to provide credentials for a CreateLocationAzureBlob request. Do not provide both parameters for the same request.

    • toBuilder

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

    • builder

      public static CreateLocationAzureBlobRequest.Builder builder()

    • serializableBuilderClass

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