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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 |
|
CLOUDFRONT_DOMAIN_FIELD_NUMBER
public static final int CLOUDFRONT_DOMAIN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREDENTIALS_SECRET_FIELD_NUMBER
public static final int CREDENTIALS_SECRET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MANAGED_PRIVATE_NETWORK_FIELD_NUMBER
public static final int MANAGED_PRIVATE_NETWORK_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TransferTypes.AwsS3Data.Builder newBuilder()
newBuilder(TransferTypes.AwsS3Data prototype)
public static TransferTypes.AwsS3Data.Builder newBuilder(TransferTypes.AwsS3Data prototype)
public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input)
public static TransferTypes.AwsS3Data parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TransferTypes.AwsS3Data parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TransferTypes.AwsS3Data parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(CodedInputStream input)
public static TransferTypes.AwsS3Data parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(InputStream input)
public static TransferTypes.AwsS3Data parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.AwsS3Data parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TransferTypes.AwsS3Data> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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];
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.
|
getCloudfrontDomain()
public String getCloudfrontDomain()
Optional. The CloudFront distribution domain name pointing to this bucket,
to use when fetching.
See
Transfer from S3 via
CloudFront
for more information.
Format: https://{id}.cloudfront.net or any valid custom domain. Must
begin with https://.
string cloudfront_domain = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The cloudfrontDomain.
|
getCloudfrontDomainBytes()
public ByteString getCloudfrontDomainBytes()
Optional. The CloudFront distribution domain name pointing to this bucket,
to use when fetching.
See
Transfer from S3 via
CloudFront
for more information.
Format: https://{id}.cloudfront.net or any valid custom domain. Must
begin with https://.
string cloudfront_domain = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for cloudfrontDomain.
|
getCredentialsSecret()
public String getCredentialsSecret()
Optional. The Resource name of a secret in Secret Manager.
AWS credentials must be stored in Secret Manager in JSON format:
{
"access_key_id": "ACCESS_KEY_ID",
"secret_access_key": "SECRET_ACCESS_KEY"
}
GoogleServiceAccount must
be granted roles/secretmanager.secretAccessor for the resource.
See Configure access to a source: Amazon S3
for more information.
If credentials_secret is specified, do not specify
role_arn or
aws_access_key.
Format: projects/{project_number}/secrets/{secret_name}
string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The credentialsSecret.
|
getCredentialsSecretBytes()
public ByteString getCredentialsSecretBytes()
Optional. The Resource name of a secret in Secret Manager.
AWS credentials must be stored in Secret Manager in JSON format:
{
"access_key_id": "ACCESS_KEY_ID",
"secret_access_key": "SECRET_ACCESS_KEY"
}
GoogleServiceAccount must
be granted roles/secretmanager.secretAccessor for the resource.
See Configure access to a source: Amazon S3
for more information.
If credentials_secret is specified, do not specify
role_arn or
aws_access_key.
Format: projects/{project_number}/secrets/{secret_name}
string credentials_secret = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for credentialsSecret.
|
getDefaultInstanceForType()
public TransferTypes.AwsS3Data getDefaultInstanceForType()
getManagedPrivateNetwork()
public boolean getManagedPrivateNetwork()
Egress bytes over a Google-managed private network.
This network is shared between other users of Storage Transfer Service.
bool managed_private_network = 8;
| Returns |
| Type |
Description |
boolean |
The managedPrivateNetwork.
|
getParserForType()
public Parser<TransferTypes.AwsS3Data> getParserForType()
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 |
| Type |
Description |
ByteString |
The bytes for path.
|
getPrivateNetworkCase()
public TransferTypes.AwsS3Data.PrivateNetworkCase getPrivateNetworkCase()
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
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.
|
hasManagedPrivateNetwork()
public boolean hasManagedPrivateNetwork()
Egress bytes over a Google-managed private network.
This network is shared between other users of Storage Transfer Service.
bool managed_private_network = 8;
| Returns |
| Type |
Description |
boolean |
Whether the managedPrivateNetwork field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TransferTypes.AwsS3Data.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes.AwsS3Data.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TransferTypes.AwsS3Data.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
