Class TransferTypes.AwsS3Data (1.54.0)

public static final class TransferTypes.AwsS3Data extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.AwsS3Data

Implements

TransferTypes.AwsS3DataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AWS_ACCESS_KEY_FIELD_NUMBER

public static final int AWS_ACCESS_KEY_FIELD_NUMBER

Field Value
Type	Description
`int`

BUCKET_NAME_FIELD_NUMBER

public static final int BUCKET_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

CLOUDFRONT_DOMAIN_FIELD_NUMBER

public static final int CLOUDFRONT_DOMAIN_FIELD_NUMBER

Field Value
Type	Description
`int`

CREDENTIALS_SECRET_FIELD_NUMBER

public static final int CREDENTIALS_SECRET_FIELD_NUMBER

Field Value
Type	Description
`int`

MANAGED_PRIVATE_NETWORK_FIELD_NUMBER

public static final int MANAGED_PRIVATE_NETWORK_FIELD_NUMBER

Field Value
Type	Description
`int`

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

Field Value
Type	Description
`int`

ROLE_ARN_FIELD_NUMBER

public static final int ROLE_ARN_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static TransferTypes.AwsS3Data getDefaultInstance()

Returns
Type	Description
`TransferTypes.AwsS3Data`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static TransferTypes.AwsS3Data.Builder newBuilder()

Returns
Type	Description
`TransferTypes.AwsS3Data.Builder`

newBuilder(TransferTypes.AwsS3Data prototype)

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

Parameter
Name	Description
`prototype`	`TransferTypes.AwsS3Data`

Returns
Type	Description
`TransferTypes.AwsS3Data.Builder`

parseDelimitedFrom(InputStream input)

public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static TransferTypes.AwsS3Data parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AwsS3Data parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static TransferTypes.AwsS3Data parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AwsS3Data parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static TransferTypes.AwsS3Data parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AwsS3Data parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static TransferTypes.AwsS3Data parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AwsS3Data parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.AwsS3Data`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<TransferTypes.AwsS3Data> parser()

Returns
Type	Description
`Parser<AwsS3Data>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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.

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`

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.

getParserForType()

public Parser<TransferTypes.AwsS3Data> getParserForType()

Returns
Type	Description
`Parser<AwsS3Data>`

Overrides

GeneratedMessageV3.getParserForType()

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.

string role_arn = 4;

Returns
Type	Description
`ByteString`	The bytes for roleArn.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TransferTypes.AwsS3Data.Builder newBuilderForType()

Returns
Type	Description
`TransferTypes.AwsS3Data.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.AwsS3Data.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`TransferTypes.AwsS3Data.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TransferTypes.AwsS3Data.Builder toBuilder()

Returns
Type	Description
`TransferTypes.AwsS3Data.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`