Class TransferTypes.AwsS3Data.Builder (1.19.0)

Version 1.19.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

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

Implements

TransferTypes.AwsS3DataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.AwsS3Data.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
TransferTypes.AwsS3Data.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.AwsS3Data.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
TransferTypes.AwsS3Data.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

getDefaultInstanceForType()

public TransferTypes.AwsS3Data getDefaultInstanceForType()

Returns
Type	Description
TransferTypes.AwsS3Data

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)