Interface TransferTypes.AwsS3DataOrBuilder (1.13.0)

Version 1.13.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

public static interface TransferTypes.AwsS3DataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAwsAccessKey()

public abstract 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 abstract 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 abstract 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 abstract 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.

getPath()

public abstract 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 abstract 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 abstract 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 abstract 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.

hasAwsAccessKey()

public abstract 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.