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
Static Fields
AWS_ACCESS_KEY_FIELD_NUMBER
public static final int AWS_ACCESS_KEY_FIELD_NUMBER
Field Value
BUCKET_NAME_FIELD_NUMBER
public static final int BUCKET_NAME_FIELD_NUMBER
Field Value
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
Field Value
ROLE_ARN_FIELD_NUMBER
public static final int ROLE_ARN_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransferTypes.AwsS3Data getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TransferTypes.AwsS3Data.Builder newBuilder()
Returns
newBuilder(TransferTypes.AwsS3Data prototype)
public static TransferTypes.AwsS3Data.Builder newBuilder(TransferTypes.AwsS3Data prototype)
Parameter
Returns
public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransferTypes.AwsS3Data parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransferTypes.AwsS3Data parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferTypes.AwsS3Data parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransferTypes.AwsS3Data parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferTypes.AwsS3Data parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferTypes.AwsS3Data parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransferTypes.AwsS3Data> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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. This field is required.
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
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. This field is required.
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
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
getParserForType()
public Parser<TransferTypes.AwsS3Data> getParserForType()
Returns
Overrides
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
getRoleArn()
public String getRoleArn()
Input only. Role arn to support temporary credentials via
AssumeRoleWithWebIdentity.
When role arn is provided, transfer service will fetch temporary
credentials for the session using AssumeRoleWithWebIdentity call for the
provided role using the [GoogleServiceAccount] for this project.
string role_arn = 4 [(.google.api.field_behavior) = INPUT_ONLY];
Returns
Type |
Description |
String |
The roleArn.
|
getRoleArnBytes()
public ByteString getRoleArnBytes()
Input only. Role arn to support temporary credentials via
AssumeRoleWithWebIdentity.
When role arn is provided, transfer service will fetch temporary
credentials for the session using AssumeRoleWithWebIdentity call for the
provided role using the [GoogleServiceAccount] for this project.
string role_arn = 4 [(.google.api.field_behavior) = INPUT_ONLY];
Returns
Type |
Description |
ByteString |
The bytes for roleArn.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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. This field is required.
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TransferTypes.AwsS3Data.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes.AwsS3Data.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TransferTypes.AwsS3Data.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions