com.google.storagetransfer.v1.proto

Interface TransferTypes.AwsS3DataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransferTypes.AwsS3Data, TransferTypes.AwsS3Data.Builder

Enclosing class:

TransferTypes

public static interface TransferTypes.AwsS3DataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
TransferTypes.AwsAccessKey	getAwsAccessKey() Input only.
TransferTypes.AwsAccessKeyOrBuilder	getAwsAccessKeyOrBuilder() Input only.
String	getBucketName() Required.
com.google.protobuf.ByteString	getBucketNameBytes() Required.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getBucketName

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

Returns:

The bucketName.

getBucketNameBytes

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

Returns:

The bytes for bucketName.

hasAwsAccessKey

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

Returns:

Whether the awsAccessKey field is set.

getAwsAccessKey

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

Returns:

The awsAccessKey.

getAwsAccessKeyOrBuilder

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

getPath

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:

The path.

getPathBytes

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;

Returns:

The bytes for path.

getRoleArn

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;

Returns:

The roleArn.

getRoleArnBytes

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;

Returns:

The bytes for roleArn.