Package com.google.storagetransfer.v1.proto

Class TransferTypes.AwsS3Data

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3Data
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.AwsS3DataOrBuilder, Serializable
Enclosing class:
TransferTypes
public static final class TransferTypes.AwsS3Data extends com.google.protobuf.GeneratedMessage implements TransferTypes.AwsS3DataOrBuilder
 An AwsS3Data resource can be a data source, but not a data sink.
 In an AwsS3Data resource, an object's name is the S3 object's key name.
Protobuf type google.storagetransfer.v1.AwsS3Data
See Also:

  • Field Details

    • BUCKET_NAME_FIELD_NUMBER

      public static final int BUCKET_NAME_FIELD_NUMBER
      See Also:

    • AWS_ACCESS_KEY_FIELD_NUMBER

      public static final int AWS_ACCESS_KEY_FIELD_NUMBER
      See Also:

    • PATH_FIELD_NUMBER

      public static final int PATH_FIELD_NUMBER
      See Also:

    • ROLE_ARN_FIELD_NUMBER

      public static final int ROLE_ARN_FIELD_NUMBER
      See Also:

    • CLOUDFRONT_DOMAIN_FIELD_NUMBER

      public static final int CLOUDFRONT_DOMAIN_FIELD_NUMBER
      See Also:

    • CREDENTIALS_SECRET_FIELD_NUMBER

      public static final int CREDENTIALS_SECRET_FIELD_NUMBER
      See Also:

    • MANAGED_PRIVATE_NETWORK_FIELD_NUMBER

      public static final int MANAGED_PRIVATE_NETWORK_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

    • getPrivateNetworkCase

      public TransferTypes.AwsS3Data.PrivateNetworkCase getPrivateNetworkCase()
      Specified by:
      getPrivateNetworkCase in interface TransferTypes.AwsS3DataOrBuilder

    • getBucketName

      public String getBucketName()
       Required. S3 Bucket name (see
 [Creating a
 bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
      string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBucketName in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The bucketName.

    • getBucketNameBytes

      public com.google.protobuf.ByteString getBucketNameBytes()
       Required. S3 Bucket name (see
 [Creating a
 bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
      string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBucketNameBytes in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The bytes for bucketName.

    • hasAwsAccessKey

      public boolean hasAwsAccessKey()
       Input only. AWS access key used to sign the API requests to the AWS S3
 bucket. Permissions on the bucket must be granted to the access ID of the
 AWS access key.

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

    • getAwsAccessKey

      public TransferTypes.AwsAccessKey getAwsAccessKey()
       Input only. AWS access key used to sign the API requests to the AWS S3
 bucket. Permissions on the bucket must be granted to the access ID of the
 AWS access key.

 For information on our data retention policy for user credentials, see
 [User credentials](/storage-transfer/docs/data-retention#user-credentials).
      .google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getAwsAccessKey in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The awsAccessKey.

    • getAwsAccessKeyOrBuilder

      public TransferTypes.AwsAccessKeyOrBuilder getAwsAccessKeyOrBuilder()
       Input only. AWS access key used to sign the API requests to the AWS S3
 bucket. Permissions on the bucket must be granted to the access ID of the
 AWS access key.

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

    • 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 = 3;
      Specified by:
      getPath in interface TransferTypes.AwsS3DataOrBuilder
      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 = 3;
      Specified by:
      getPathBytes in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The bytes for path.

    • getRoleArn

      public String getRoleArn()
       The Amazon Resource Name (ARN) of the role to support temporary
 credentials via `AssumeRoleWithWebIdentity`. For more information about
 ARNs, see [IAM
 ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).

 When a role ARN is provided, Transfer Service fetches temporary
 credentials for the session using a `AssumeRoleWithWebIdentity` call for
 the provided role using the
 [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] for
 this project.
      string role_arn = 4;
      Specified by:
      getRoleArn in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The roleArn.

    • getRoleArnBytes

      public com.google.protobuf.ByteString getRoleArnBytes()
       The Amazon Resource Name (ARN) of the role to support temporary
 credentials via `AssumeRoleWithWebIdentity`. For more information about
 ARNs, see [IAM
 ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).

 When a role ARN is provided, Transfer Service fetches temporary
 credentials for the session using a `AssumeRoleWithWebIdentity` call for
 the provided role using the
 [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] for
 this project.
      string role_arn = 4;
      Specified by:
      getRoleArnBytes in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The bytes for roleArn.

    • getCloudfrontDomain

      public String getCloudfrontDomain()
       Optional. The CloudFront distribution domain name pointing to this bucket,
 to use when fetching.

 See
 [Transfer from S3 via
 CloudFront](https://cloud.google.com/storage-transfer/docs/s3-cloudfront)
 for more information.

 Format: `https://{id}.cloudfront.net` or any valid custom domain. Must
 begin with `https://`.
      string cloudfront_domain = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudfrontDomain in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The cloudfrontDomain.

    • getCloudfrontDomainBytes

      public com.google.protobuf.ByteString getCloudfrontDomainBytes()
       Optional. The CloudFront distribution domain name pointing to this bucket,
 to use when fetching.

 See
 [Transfer from S3 via
 CloudFront](https://cloud.google.com/storage-transfer/docs/s3-cloudfront)
 for more information.

 Format: `https://{id}.cloudfront.net` or any valid custom domain. Must
 begin with `https://`.
      string cloudfront_domain = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudfrontDomainBytes in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The bytes for cloudfrontDomain.

    • getCredentialsSecret

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

 AWS credentials must be stored in Secret Manager in JSON format:

 {
 "access_key_id": "ACCESS_KEY_ID",
 "secret_access_key": "SECRET_ACCESS_KEY"
 }

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

 See [Configure access to a source: Amazon S3]
 (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager)
 for more information.

 If `credentials_secret` is specified, do not specify
 [role_arn][google.storagetransfer.v1.AwsS3Data.role_arn] or
 [aws_access_key][google.storagetransfer.v1.AwsS3Data.aws_access_key].

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

    • getCredentialsSecretBytes

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

 AWS credentials must be stored in Secret Manager in JSON format:

 {
 "access_key_id": "ACCESS_KEY_ID",
 "secret_access_key": "SECRET_ACCESS_KEY"
 }

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

 See [Configure access to a source: Amazon S3]
 (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager)
 for more information.

 If `credentials_secret` is specified, do not specify
 [role_arn][google.storagetransfer.v1.AwsS3Data.role_arn] or
 [aws_access_key][google.storagetransfer.v1.AwsS3Data.aws_access_key].

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

    • hasManagedPrivateNetwork

      public boolean hasManagedPrivateNetwork()
       Egress bytes over a Google-managed private network.
 This network is shared between other users of Storage Transfer Service.
      bool managed_private_network = 8;
      Specified by:
      hasManagedPrivateNetwork in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      Whether the managedPrivateNetwork field is set.

    • getManagedPrivateNetwork

      public boolean getManagedPrivateNetwork()
       Egress bytes over a Google-managed private network.
 This network is shared between other users of Storage Transfer Service.
      bool managed_private_network = 8;
      Specified by:
      getManagedPrivateNetwork in interface TransferTypes.AwsS3DataOrBuilder
      Returns:
      The managedPrivateNetwork.

    • 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.AwsS3Data parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TransferTypes.AwsS3Data 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.AwsS3Data parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TransferTypes.AwsS3Data.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TransferTypes.AwsS3Data getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<TransferTypes.AwsS3Data> 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.AwsS3Data getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder