public static final class TransferTypes.AwsS3Data.Builder extends com.google.protobuf.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| Modifier and Type | Method and Description |
|---|---|
TransferTypes.AwsS3Data.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
TransferTypes.AwsS3Data |
build() |
TransferTypes.AwsS3Data |
buildPartial() |
TransferTypes.AwsS3Data.Builder |
clear() |
TransferTypes.AwsS3Data.Builder |
clearAwsAccessKey()
Input only.
|
TransferTypes.AwsS3Data.Builder |
clearBucketName()
Required.
|
TransferTypes.AwsS3Data.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
TransferTypes.AwsS3Data.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
TransferTypes.AwsS3Data.Builder |
clearPath()
Root path to transfer objects.
|
TransferTypes.AwsS3Data.Builder |
clearRoleArn()
The Amazon Resource Name (ARN) of the role to support temporary
credentials via `AssumeRoleWithWebIdentity`.
|
TransferTypes.AwsS3Data.Builder |
clone() |
TransferTypes.AwsAccessKey |
getAwsAccessKey()
Input only.
|
TransferTypes.AwsAccessKey.Builder |
getAwsAccessKeyBuilder()
Input only.
|
TransferTypes.AwsAccessKeyOrBuilder |
getAwsAccessKeyOrBuilder()
Input only.
|
String |
getBucketName()
Required.
|
com.google.protobuf.ByteString |
getBucketNameBytes()
Required.
|
TransferTypes.AwsS3Data |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getPath()
Root path to transfer objects.
|
com.google.protobuf.ByteString |
getPathBytes()
Root path to transfer objects.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) of the role to support temporary
credentials via `AssumeRoleWithWebIdentity`.
|
com.google.protobuf.ByteString |
getRoleArnBytes()
The Amazon Resource Name (ARN) of the role to support temporary
credentials via `AssumeRoleWithWebIdentity`.
|
boolean |
hasAwsAccessKey()
Input only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
TransferTypes.AwsS3Data.Builder |
mergeAwsAccessKey(TransferTypes.AwsAccessKey value)
Input only.
|
TransferTypes.AwsS3Data.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
TransferTypes.AwsS3Data.Builder |
mergeFrom(com.google.protobuf.Message other) |
TransferTypes.AwsS3Data.Builder |
mergeFrom(TransferTypes.AwsS3Data other) |
TransferTypes.AwsS3Data.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
TransferTypes.AwsS3Data.Builder |
setAwsAccessKey(TransferTypes.AwsAccessKey.Builder builderForValue)
Input only.
|
TransferTypes.AwsS3Data.Builder |
setAwsAccessKey(TransferTypes.AwsAccessKey value)
Input only.
|
TransferTypes.AwsS3Data.Builder |
setBucketName(String value)
Required.
|
TransferTypes.AwsS3Data.Builder |
setBucketNameBytes(com.google.protobuf.ByteString value)
Required.
|
TransferTypes.AwsS3Data.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
TransferTypes.AwsS3Data.Builder |
setPath(String value)
Root path to transfer objects.
|
TransferTypes.AwsS3Data.Builder |
setPathBytes(com.google.protobuf.ByteString value)
Root path to transfer objects.
|
TransferTypes.AwsS3Data.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
TransferTypes.AwsS3Data.Builder |
setRoleArn(String value)
The Amazon Resource Name (ARN) of the role to support temporary
credentials via `AssumeRoleWithWebIdentity`.
|
TransferTypes.AwsS3Data.Builder |
setRoleArnBytes(com.google.protobuf.ByteString value)
The Amazon Resource Name (ARN) of the role to support temporary
credentials via `AssumeRoleWithWebIdentity`.
|
TransferTypes.AwsS3Data.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic TransferTypes.AwsS3Data build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic TransferTypes.AwsS3Data buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic TransferTypes.AwsS3Data.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder mergeFrom(TransferTypes.AwsS3Data other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public TransferTypes.AwsS3Data.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.AwsS3Data.Builder>IOExceptionpublic 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];getBucketName in interface TransferTypes.AwsS3DataOrBuilderpublic 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];getBucketNameBytes in interface TransferTypes.AwsS3DataOrBuilderpublic TransferTypes.AwsS3Data.Builder setBucketName(String value)
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];value - The bucketName to set.public TransferTypes.AwsS3Data.Builder clearBucketName()
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];public TransferTypes.AwsS3Data.Builder setBucketNameBytes(com.google.protobuf.ByteString value)
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];value - The bytes for bucketName to set.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];
hasAwsAccessKey in interface TransferTypes.AwsS3DataOrBuilderpublic 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];
getAwsAccessKey in interface TransferTypes.AwsS3DataOrBuilderpublic 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](/storage-transfer/docs/data-retention#user-credentials).
.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];
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](/storage-transfer/docs/data-retention#user-credentials).
.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];
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](/storage-transfer/docs/data-retention#user-credentials).
.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];
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](/storage-transfer/docs/data-retention#user-credentials).
.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];
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](/storage-transfer/docs/data-retention#user-credentials).
.google.storagetransfer.v1.AwsAccessKey aws_access_key = 2 [(.google.api.field_behavior) = INPUT_ONLY];
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];
getAwsAccessKeyOrBuilder in interface TransferTypes.AwsS3DataOrBuilderpublic 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;getPath in interface TransferTypes.AwsS3DataOrBuilderpublic 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;getPathBytes in interface TransferTypes.AwsS3DataOrBuilderpublic 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;value - The path to set.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;public TransferTypes.AwsS3Data.Builder setPathBytes(com.google.protobuf.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;value - The bytes for path to set.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;getRoleArn in interface TransferTypes.AwsS3DataOrBuilderpublic 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;getRoleArnBytes in interface TransferTypes.AwsS3DataOrBuilderpublic 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](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;value - The roleArn to set.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](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;public TransferTypes.AwsS3Data.Builder setRoleArnBytes(com.google.protobuf.ByteString value)
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;value - The bytes for roleArn to set.public final TransferTypes.AwsS3Data.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>public final TransferTypes.AwsS3Data.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AwsS3Data.Builder>Copyright © 2022 Google LLC. All rights reserved.