Package com.google.storagetransfer.v1.proto

Interface TransferTypes.AwsS3DataOrBuilder

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

  • Method Details

    • getBucketName

      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];
      Returns:
      The bucketName.

    • getBucketNameBytes

      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];
      Returns:
      The bytes for bucketName.

    • hasAwsAccessKey

      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];
      Returns:
      Whether the awsAccessKey field is set.

    • getAwsAccessKey

      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];
      Returns:
      The awsAccessKey.

    • getAwsAccessKeyOrBuilder

      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];

    • 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 '/'.
      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 '/'.
      string path = 3;
      Returns:
      The bytes for path.

    • getRoleArn

      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;
      Returns:
      The roleArn.

    • getRoleArnBytes

      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;
      Returns:
      The bytes for roleArn.

    • getCloudfrontDomain

      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];
      Returns:
      The cloudfrontDomain.

    • getCloudfrontDomainBytes

      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];
      Returns:
      The bytes for cloudfrontDomain.

    • getCredentialsSecret

      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];
      Returns:
      The credentialsSecret.

    • getCredentialsSecretBytes

      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];
      Returns:
      The bytes for credentialsSecret.

    • hasManagedPrivateNetwork

      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;
      Returns:
      Whether the managedPrivateNetwork field is set.

    • getManagedPrivateNetwork

      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;
      Returns:
      The managedPrivateNetwork.

    • getPrivateNetworkCase

      TransferTypes.AwsS3Data.PrivateNetworkCase getPrivateNetworkCase()