Package com.google.storagetransfer.v1.proto

Class TransferTypes.AzureBlobStorageData

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.storagetransfer.v1.proto.TransferTypes.AzureBlobStorageData
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.AzureBlobStorageDataOrBuilder, Serializable
Enclosing class:
TransferTypes
public static final class TransferTypes.AzureBlobStorageData extends com.google.protobuf.GeneratedMessage implements TransferTypes.AzureBlobStorageDataOrBuilder
 An AzureBlobStorageData resource can be a data source, but not a data sink.
 An AzureBlobStorageData resource represents one Azure container. The storage
 account determines the [Azure
 endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints).
 In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob
 Storage blob's key
 name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names).
Protobuf type google.storagetransfer.v1.AzureBlobStorageData
See Also:

  • Field Details

    • STORAGE_ACCOUNT_FIELD_NUMBER

      public static final int STORAGE_ACCOUNT_FIELD_NUMBER
      See Also:

    • AZURE_CREDENTIALS_FIELD_NUMBER

      public static final int AZURE_CREDENTIALS_FIELD_NUMBER
      See Also:

    • CONTAINER_FIELD_NUMBER

      public static final int CONTAINER_FIELD_NUMBER
      See Also:

    • PATH_FIELD_NUMBER

      public static final int PATH_FIELD_NUMBER
      See Also:

    • CREDENTIALS_SECRET_FIELD_NUMBER

      public static final int CREDENTIALS_SECRET_FIELD_NUMBER
      See Also:

    • FEDERATED_IDENTITY_CONFIG_FIELD_NUMBER

      public static final int FEDERATED_IDENTITY_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getStorageAccount

      public String getStorageAccount()
       Required. The name of the Azure Storage account.
      string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStorageAccount in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The storageAccount.

    • getStorageAccountBytes

      public com.google.protobuf.ByteString getStorageAccountBytes()
       Required. The name of the Azure Storage account.
      string storage_account = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStorageAccountBytes in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The bytes for storageAccount.

    • hasAzureCredentials

      public boolean hasAzureCredentials()
       Required. Input only. Credentials used to authenticate API requests to
 Azure.

 For information on our data retention policy for user credentials, see
 [User credentials](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      hasAzureCredentials in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      Whether the azureCredentials field is set.

    • getAzureCredentials

      public TransferTypes.AzureCredentials getAzureCredentials()
       Required. Input only. Credentials used to authenticate API requests to
 Azure.

 For information on our data retention policy for user credentials, see
 [User credentials](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getAzureCredentials in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The azureCredentials.

    • getAzureCredentialsOrBuilder

      public TransferTypes.AzureCredentialsOrBuilder getAzureCredentialsOrBuilder()
       Required. Input only. Credentials used to authenticate API requests to
 Azure.

 For information on our data retention policy for user credentials, see
 [User credentials](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AzureCredentials azure_credentials = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getAzureCredentialsOrBuilder in interface TransferTypes.AzureBlobStorageDataOrBuilder

    • getContainer

      public String getContainer()
       Required. The container to transfer from the Azure Storage account.
      string container = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContainer in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The container.

    • getContainerBytes

      public com.google.protobuf.ByteString getContainerBytes()
       Required. The container to transfer from the Azure Storage account.
      string container = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContainerBytes in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The bytes for container.

    • getPath

      public String getPath()
       Root path to transfer objects.

 Must be an empty string or full path name that ends with a '/'. This field
 is treated as an object prefix. As such, it should generally not begin with
 a '/'.
      string path = 5;
      Specified by:
      getPath in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The path.

    • getPathBytes

      public com.google.protobuf.ByteString getPathBytes()
       Root path to transfer objects.

 Must be an empty string or full path name that ends with a '/'. This field
 is treated as an object prefix. As such, it should generally not begin with
 a '/'.
      string path = 5;
      Specified by:
      getPathBytes in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The bytes for path.

    • getCredentialsSecret

      public String getCredentialsSecret()
       Optional. The Resource name of a secret in Secret Manager.

 The Azure SAS token must be stored in Secret Manager in JSON format:

 {
 "sas_token" : "SAS_TOKEN"
 }

 [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] must
 be granted `roles/secretmanager.secretAccessor` for the resource.

 See [Configure access to a source: Microsoft Azure Blob Storage]
 (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
 for more information.

 If `credentials_secret` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials].

 Format: `projects/{project_number}/secrets/{secret_name}`
      string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCredentialsSecret in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The credentialsSecret.

    • getCredentialsSecretBytes

      public com.google.protobuf.ByteString getCredentialsSecretBytes()
       Optional. The Resource name of a secret in Secret Manager.

 The Azure SAS token must be stored in Secret Manager in JSON format:

 {
 "sas_token" : "SAS_TOKEN"
 }

 [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] must
 be granted `roles/secretmanager.secretAccessor` for the resource.

 See [Configure access to a source: Microsoft Azure Blob Storage]
 (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
 for more information.

 If `credentials_secret` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials].

 Format: `projects/{project_number}/secrets/{secret_name}`
      string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCredentialsSecretBytes in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The bytes for credentialsSecret.

    • hasFederatedIdentityConfig

      public boolean hasFederatedIdentityConfig()
       Optional. Federated identity config of a user registered Azure application.

 If `federated_identity_config` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials]
 or
 [credentials_secret][google.storagetransfer.v1.AzureBlobStorageData.credentials_secret].
      .google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasFederatedIdentityConfig in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      Whether the federatedIdentityConfig field is set.

    • getFederatedIdentityConfig

      public TransferTypes.AzureBlobStorageData.FederatedIdentityConfig getFederatedIdentityConfig()
       Optional. Federated identity config of a user registered Azure application.

 If `federated_identity_config` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials]
 or
 [credentials_secret][google.storagetransfer.v1.AzureBlobStorageData.credentials_secret].
      .google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFederatedIdentityConfig in interface TransferTypes.AzureBlobStorageDataOrBuilder
      Returns:
      The federatedIdentityConfig.

    • getFederatedIdentityConfigOrBuilder

      public TransferTypes.AzureBlobStorageData.FederatedIdentityConfigOrBuilder getFederatedIdentityConfigOrBuilder()
       Optional. Federated identity config of a user registered Azure application.

 If `federated_identity_config` is specified, do not specify
 [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials]
 or
 [credentials_secret][google.storagetransfer.v1.AzureBlobStorageData.credentials_secret].
      .google.storagetransfer.v1.AzureBlobStorageData.FederatedIdentityConfig federated_identity_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFederatedIdentityConfigOrBuilder in interface TransferTypes.AzureBlobStorageDataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferTypes.AzureBlobStorageData parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferTypes.AzureBlobStorageData parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.AzureBlobStorageData parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TransferTypes.AzureBlobStorageData.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TransferTypes.AzureBlobStorageData.Builder newBuilder()

    • newBuilder

      public static TransferTypes.AzureBlobStorageData.Builder newBuilder(TransferTypes.AzureBlobStorageData prototype)

    • toBuilder

      public TransferTypes.AzureBlobStorageData.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TransferTypes.AzureBlobStorageData.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TransferTypes.AzureBlobStorageData getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransferTypes.AzureBlobStorageData> parser()

    • getParserForType

      public com.google.protobuf.Parser<TransferTypes.AzureBlobStorageData> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TransferTypes.AzureBlobStorageData getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder