AwsS3Data (Storage Transfer API v1-rev20240622-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.storagetransfer.v1.model.AwsS3Data

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AwsS3Data
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

AwsS3Data()

Constructors
Constructor and Description
`AwsS3Data()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsS3Data`	`clone()`
`AwsAccessKey`	`getAwsAccessKey()` Input only.
`String`	`getBucketName()` Required.
`String`	`getCloudfrontDomain()` Optional.
`String`	`getCredentialsSecret()` Optional.
`Boolean`	`getManagedPrivateNetwork()` Egress bytes over a Google-managed private network.
`String`	`getPath()` Root path to transfer objects.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role to support temporary credentials via `AssumeRoleWithWebIdentity`.
`AwsS3Data`	`set(String fieldName, Object value)`
`AwsS3Data`	`setAwsAccessKey(AwsAccessKey awsAccessKey)` Input only.
`AwsS3Data`	`setBucketName(String bucketName)` Required.
`AwsS3Data`	`setCloudfrontDomain(String cloudfrontDomain)` Optional.
`AwsS3Data`	`setCredentialsSecret(String credentialsSecret)` Optional.
`AwsS3Data`	`setManagedPrivateNetwork(Boolean managedPrivateNetwork)` Egress bytes over a Google-managed private network.
`AwsS3Data`	`setPath(String path)` Root path to transfer objects.
`AwsS3Data`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role to support temporary credentials via `AssumeRoleWithWebIdentity`.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - AwsS3Data
```
public AwsS3Data()
```
- Method Detail
  - getAwsAccessKey
```
public 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).
    
    Returns:
    
    value or null for none
  - setAwsAccessKey
```
public AwsS3Data setAwsAccessKey(AwsAccessKey awsAccessKey)
```
    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).
    
    Parameters:
    
    awsAccessKey - awsAccessKey or null for none
  - 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)).
    
    Returns:
    
    value or null for none
  - setBucketName
```
public AwsS3Data setBucketName(String bucketName)
```
    Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location- example.html)).
    
    Parameters:
    
    bucketName - bucketName or null for none
  - getCloudfrontDomain
```
public String getCloudfrontDomain()
```
    Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching. See [Transfer from S3 via CloudFront](https://cloud.google.com/storage- transfer/docs/s3-cloudfront) for more information. Format: `https://{id}.cloudfront.net` or any valid custom domain. Must begin with `https://`.
    
    Returns:
    
    value or null for none
  - setCloudfrontDomain
```
public AwsS3Data setCloudfrontDomain(String cloudfrontDomain)
```
    Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching. See [Transfer from S3 via CloudFront](https://cloud.google.com/storage- transfer/docs/s3-cloudfront) for more information. Format: `https://{id}.cloudfront.net` or any valid custom domain. Must begin with `https://`.
    
    Parameters:
    
    cloudfrontDomain - cloudfrontDomain or null for none
  - 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] (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager) for more information. If `credentials_secret` is specified, do not specify role_arn or aws_access_key. Format: `projects/{project_number}/secrets/{secret_name}`
    
    Returns:
    
    value or null for none
  - setCredentialsSecret
```
public AwsS3Data setCredentialsSecret(String credentialsSecret)
```
    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] (https://cloud.google.com/storage-transfer/docs/source-amazon-s3#secret_manager) for more information. If `credentials_secret` is specified, do not specify role_arn or aws_access_key. Format: `projects/{project_number}/secrets/{secret_name}`
    
    Parameters:
    
    credentialsSecret - credentialsSecret or null for none
  - getManagedPrivateNetwork
```
public Boolean getManagedPrivateNetwork()
```
    Egress bytes over a Google-managed private network. This network is shared between other users of Storage Transfer Service.
    
    Returns:
    
    value or null for none
  - setManagedPrivateNetwork
```
public AwsS3Data setManagedPrivateNetwork(Boolean managedPrivateNetwork)
```
    Egress bytes over a Google-managed private network. This network is shared between other users of Storage Transfer Service.
    
    Parameters:
    
    managedPrivateNetwork - managedPrivateNetwork or null for none
  - 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 '/'.
    
    Returns:
    
    value or null for none
  - setPath
```
public AwsS3Data setPath(String path)
```
    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 '/'.
    
    Parameters:
    
    path - path or null for none
  - 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 for this project.
    
    Returns:
    
    value or null for none
  - setRoleArn
```
public AwsS3Data setRoleArn(String roleArn)
```
    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 for this project.
    
    Parameters:
    
    roleArn - roleArn or null for none
  - set
```
public AwsS3Data set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AwsS3Data clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class AwsS3Data

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AwsS3Data

Method Detail

getAwsAccessKey

setAwsAccessKey

getBucketName

setBucketName

getCloudfrontDomain

setCloudfrontDomain

getCredentialsSecret

setCredentialsSecret

getManagedPrivateNetwork

setManagedPrivateNetwork

getPath

setPath

getRoleArn

setRoleArn

set

clone