com.google.storagetransfer.v1.proto

Class TransferTypes.AwsS3Data

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.storagetransfer.v1.proto.TransferTypes.AwsS3Data

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.AwsS3DataOrBuilder, Serializable

Enclosing class:

TransferTypes

public static final class TransferTypes.AwsS3Data
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferTypes.AwsS3Data.Builder An AwsS3Data resource can be a data source, but not a data sink.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AWS_ACCESS_KEY_FIELD_NUMBER
static int	BUCKET_NAME_FIELD_NUMBER
static int	PATH_FIELD_NUMBER
static int	ROLE_ARN_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
TransferTypes.AwsAccessKey	getAwsAccessKey() Input only.
TransferTypes.AwsAccessKeyOrBuilder	getAwsAccessKeyOrBuilder() Input only.
String	getBucketName() Required.
com.google.protobuf.ByteString	getBucketNameBytes() Required.
static TransferTypes.AwsS3Data	getDefaultInstance()
TransferTypes.AwsS3Data	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<TransferTypes.AwsS3Data>	getParserForType()
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`.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAwsAccessKey() Input only.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TransferTypes.AwsS3Data.Builder	newBuilder()
static TransferTypes.AwsS3Data.Builder	newBuilder(TransferTypes.AwsS3Data prototype)
TransferTypes.AwsS3Data.Builder	newBuilderForType()
protected TransferTypes.AwsS3Data.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TransferTypes.AwsS3Data	parseDelimitedFrom(InputStream input)
static TransferTypes.AwsS3Data	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.AwsS3Data	parseFrom(byte[] data)
static TransferTypes.AwsS3Data	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.AwsS3Data	parseFrom(ByteBuffer data)
static TransferTypes.AwsS3Data	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.AwsS3Data	parseFrom(com.google.protobuf.ByteString data)
static TransferTypes.AwsS3Data	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.AwsS3Data	parseFrom(com.google.protobuf.CodedInputStream input)
static TransferTypes.AwsS3Data	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.AwsS3Data	parseFrom(InputStream input)
static TransferTypes.AwsS3Data	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TransferTypes.AwsS3Data>	parser()
TransferTypes.AwsS3Data.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BUCKET_NAME_FIELD_NUMBER

public static final int BUCKET_NAME_FIELD_NUMBER

See Also:

Constant Field Values

AWS_ACCESS_KEY_FIELD_NUMBER

public static final int AWS_ACCESS_KEY_FIELD_NUMBER

See Also:

Constant Field Values

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

ROLE_ARN_FIELD_NUMBER

public static final int ROLE_ARN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getBucketName

public 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];

Specified by:

getBucketName in interface TransferTypes.AwsS3DataOrBuilder

Returns:

The bucketName.

getBucketNameBytes

public 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];

Specified by:

getBucketNameBytes in interface TransferTypes.AwsS3DataOrBuilder

Returns:

The bytes for bucketName.

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](/storage-transfer/docs/data-retention#user-credentials).
 

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

Specified by:

hasAwsAccessKey in interface TransferTypes.AwsS3DataOrBuilder

Returns:

Whether the awsAccessKey field is set.

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](/storage-transfer/docs/data-retention#user-credentials).
 

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

Specified by:

getAwsAccessKey in interface TransferTypes.AwsS3DataOrBuilder

Returns:

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](/storage-transfer/docs/data-retention#user-credentials).
 

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

Specified by:

getAwsAccessKeyOrBuilder in interface TransferTypes.AwsS3DataOrBuilder

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;

Specified by:

getPath in interface TransferTypes.AwsS3DataOrBuilder

Returns:

The path.

getPathBytes

public 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;

Specified by:

getPathBytes in interface TransferTypes.AwsS3DataOrBuilder

Returns:

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](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;

Specified by:

getRoleArn in interface TransferTypes.AwsS3DataOrBuilder

Returns:

The roleArn.

getRoleArnBytes

public 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;

Specified by:

getRoleArnBytes in interface TransferTypes.AwsS3DataOrBuilder

Returns:

The bytes for roleArn.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static TransferTypes.AwsS3Data parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public TransferTypes.AwsS3Data.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TransferTypes.AwsS3Data.Builder newBuilder()

newBuilder

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

toBuilder

public TransferTypes.AwsS3Data.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TransferTypes.AwsS3Data.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TransferTypes.AwsS3Data getDefaultInstance()

parser

public static com.google.protobuf.Parser<TransferTypes.AwsS3Data> parser()

getParserForType

public com.google.protobuf.Parser<TransferTypes.AwsS3Data> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TransferTypes.AwsS3Data getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder