Class TransferTypes.AwsS3Data.Builder (1.49.0) 

public static final class TransferTypes.AwsS3Data.Builder extends GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.AwsS3Data.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.AwsS3Data.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

build()

public TransferTypes.AwsS3Data build()
Returns
Type Description
TransferTypes.AwsS3Data

buildPartial()

public TransferTypes.AwsS3Data buildPartial()
Returns
Type Description
TransferTypes.AwsS3Data

clear()

public TransferTypes.AwsS3Data.Builder clear()
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

clearAwsAccessKey()

public TransferTypes.AwsS3Data.Builder clearAwsAccessKey()

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AwsS3Data.Builder

clearBucketName()

public TransferTypes.AwsS3Data.Builder clearBucketName()

Required. S3 Bucket name (see Creating a bucket).

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

clearCloudfrontDomain()

public TransferTypes.AwsS3Data.Builder clearCloudfrontDomain()

Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

See Transfer from S3 via 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
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

clearCredentialsSecret()

public TransferTypes.AwsS3Data.Builder clearCredentialsSecret()

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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Amazon S3 for more information.

If credentials_secret is specified, do not specify role_arn or aws_access_key.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.AwsS3Data.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

clearManagedPrivateNetwork()

public TransferTypes.AwsS3Data.Builder clearManagedPrivateNetwork()

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
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.AwsS3Data.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

clearPath()

public TransferTypes.AwsS3Data.Builder clearPath()

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
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

clearPrivateNetwork()

public TransferTypes.AwsS3Data.Builder clearPrivateNetwork()
Returns
Type Description
TransferTypes.AwsS3Data.Builder

clearRoleArn()

public TransferTypes.AwsS3Data.Builder clearRoleArn()

The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM 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 for this project.

string role_arn = 4;

Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

clone()

public TransferTypes.AwsS3Data.Builder clone()
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AwsAccessKey

The awsAccessKey.

getAwsAccessKeyBuilder()

public TransferTypes.AwsAccessKey.Builder getAwsAccessKeyBuilder()

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AwsAccessKey.Builder

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TransferTypes.AwsAccessKeyOrBuilder

getBucketName()

public String getBucketName()

Required. S3 Bucket name (see Creating a bucket).

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The bucketName.

getBucketNameBytes()

public ByteString getBucketNameBytes()

Required. S3 Bucket name (see Creating a bucket).

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for bucketName.

getCloudfrontDomain()

public String getCloudfrontDomain()

Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

See Transfer from S3 via 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
Type Description
String

The cloudfrontDomain.

getCloudfrontDomainBytes()

public ByteString getCloudfrontDomainBytes()

Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

See Transfer from S3 via 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
Type Description
ByteString

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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Amazon S3 for more information.

If credentials_secret is specified, do not specify role_arn or aws_access_key.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The credentialsSecret.

getCredentialsSecretBytes()

public 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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Amazon S3 for more information.

If credentials_secret is specified, do not specify role_arn or aws_access_key.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for credentialsSecret.

getDefaultInstanceForType()

public TransferTypes.AwsS3Data getDefaultInstanceForType()
Returns
Type Description
TransferTypes.AwsS3Data

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
boolean

The managedPrivateNetwork.

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;

Returns
Type Description
String

The path.

getPathBytes()

public 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
Type Description
ByteString

The bytes for path.

getPrivateNetworkCase()

public TransferTypes.AwsS3Data.PrivateNetworkCase getPrivateNetworkCase()
Returns
Type Description
TransferTypes.AwsS3Data.PrivateNetworkCase

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.

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 for this project.

string role_arn = 4;

Returns
Type Description
String

The roleArn.

getRoleArnBytes()

public ByteString getRoleArnBytes()

The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM 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 for this project.

string role_arn = 4;

Returns
Type Description
ByteString

The bytes for roleArn.

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the awsAccessKey field is set.

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;

Returns
Type Description
boolean

Whether the managedPrivateNetwork field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAwsAccessKey(TransferTypes.AwsAccessKey value)

public TransferTypes.AwsS3Data.Builder mergeAwsAccessKey(TransferTypes.AwsAccessKey value)

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value TransferTypes.AwsAccessKey
Returns
Type Description
TransferTypes.AwsS3Data.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.AwsS3Data.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.AwsS3Data.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

mergeFrom(TransferTypes.AwsS3Data other)

public TransferTypes.AwsS3Data.Builder mergeFrom(TransferTypes.AwsS3Data other)
Parameter
Name Description
other TransferTypes.AwsS3Data
Returns
Type Description
TransferTypes.AwsS3Data.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.AwsS3Data.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

setAwsAccessKey(TransferTypes.AwsAccessKey value)

public TransferTypes.AwsS3Data.Builder setAwsAccessKey(TransferTypes.AwsAccessKey value)

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value TransferTypes.AwsAccessKey
Returns
Type Description
TransferTypes.AwsS3Data.Builder

setAwsAccessKey(TransferTypes.AwsAccessKey.Builder builderForValue)

public TransferTypes.AwsS3Data.Builder setAwsAccessKey(TransferTypes.AwsAccessKey.Builder builderForValue)

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.

.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
builderForValue TransferTypes.AwsAccessKey.Builder
Returns
Type Description
TransferTypes.AwsS3Data.Builder

setBucketName(String value)

public TransferTypes.AwsS3Data.Builder setBucketName(String value)

Required. S3 Bucket name (see Creating a bucket).

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The bucketName to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setBucketNameBytes(ByteString value)

public TransferTypes.AwsS3Data.Builder setBucketNameBytes(ByteString value)

Required. S3 Bucket name (see Creating a bucket).

string bucket_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for bucketName to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setCloudfrontDomain(String value)

public TransferTypes.AwsS3Data.Builder setCloudfrontDomain(String value)

Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

See Transfer from S3 via 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];

Parameter
Name Description
value String

The cloudfrontDomain to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setCloudfrontDomainBytes(ByteString value)

public TransferTypes.AwsS3Data.Builder setCloudfrontDomainBytes(ByteString value)

Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

See Transfer from S3 via 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];

Parameter
Name Description
value ByteString

The bytes for cloudfrontDomain to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setCredentialsSecret(String value)

public TransferTypes.AwsS3Data.Builder setCredentialsSecret(String value)

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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Amazon S3 for more information.

If credentials_secret is specified, do not specify role_arn or aws_access_key.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The credentialsSecret to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setCredentialsSecretBytes(ByteString value)

public TransferTypes.AwsS3Data.Builder setCredentialsSecretBytes(ByteString value)

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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Amazon S3 for more information.

If credentials_secret is specified, do not specify role_arn or aws_access_key.

Format: projects/{project_number}/secrets/{secret_name}

string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for credentialsSecret to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.AwsS3Data.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

setManagedPrivateNetwork(boolean value)

public TransferTypes.AwsS3Data.Builder setManagedPrivateNetwork(boolean value)

Egress bytes over a Google-managed private network. This network is shared between other users of Storage Transfer Service.

bool managed_private_network = 8;

Parameter
Name Description
value boolean

The managedPrivateNetwork to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setPath(String value)

public TransferTypes.AwsS3Data.Builder setPath(String value)

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;

Parameter
Name Description
value String

The path to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setPathBytes(ByteString value)

public TransferTypes.AwsS3Data.Builder setPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for path to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.AwsS3Data.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides

setRoleArn(String value)

public TransferTypes.AwsS3Data.Builder setRoleArn(String value)

The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM 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 for this project.

string role_arn = 4;

Parameter
Name Description
value String

The roleArn to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setRoleArnBytes(ByteString value)

public TransferTypes.AwsS3Data.Builder setRoleArnBytes(ByteString value)

The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM 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 for this project.

string role_arn = 4;

Parameter
Name Description
value ByteString

The bytes for roleArn to set.
Returns
Type Description
TransferTypes.AwsS3Data.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.AwsS3Data.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.AwsS3Data.Builder
Overrides