Package com.google.storagetransfer.v1.proto

Interface TransferTypes.GcsDataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransferTypes.GcsData, TransferTypes.GcsData.Builder
Enclosing class:
TransferTypes
public static interface TransferTypes.GcsDataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBucketName()
    Required.
    com.google.protobuf.ByteString
    getBucketNameBytes()
    Required.
    boolean
    getManagedFolderTransferEnabled()
    Preview.
    String
    getPath()
    Root path to transfer objects.
    com.google.protobuf.ByteString
    getPathBytes()
    Root path to transfer objects.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getBucketName

      String getBucketName()
       Required. Cloud Storage bucket name. Must meet
 [Bucket Name Requirements](/storage/docs/naming#requirements).
      string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bucketName.

    • getBucketNameBytes

      com.google.protobuf.ByteString getBucketNameBytes()
       Required. Cloud Storage bucket name. Must meet
 [Bucket Name Requirements](/storage/docs/naming#requirements).
      string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for bucketName.

    • getPath

      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 '/'.

 The root path value must meet
 [Object Name Requirements](/storage/docs/naming#objectnames).
      string path = 3;
      Returns:
      The path.

    • getPathBytes

      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 '/'.

 The root path value must meet
 [Object Name Requirements](/storage/docs/naming#objectnames).
      string path = 3;
      Returns:
      The bytes for path.

    • getManagedFolderTransferEnabled

      boolean getManagedFolderTransferEnabled()
       Preview. Enables the transfer of managed folders between Cloud Storage
 buckets. Set this option on the gcs_data_source.

 If set to true:

 - Managed folders in the source bucket are transferred to the
 destination bucket.
 - Managed folders in the destination bucket are overwritten. Other
 OVERWRITE options are not supported.

 See
 [Transfer Cloud Storage managed
 folders](/storage-transfer/docs/managed-folders).
      bool managed_folder_transfer_enabled = 4;
      Returns:
      The managedFolderTransferEnabled.