Class TransferTypes.AwsS3Data (1.11.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

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

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

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.

getDefaultInstanceForType()

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

getParserForType()

public Parser<TransferTypes.AwsS3Data> getParserForType()
Returns
Type Description
Parser<AwsS3Data>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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 Exceptions
Type Description
IOException