Class StorageBucketObjectConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.storage_bucket_object.StorageBucketObjectConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<StorageBucketObjectConfig>
- Enclosing interface:
- StorageBucketObjectConfig
@Stability(Stable) public static final class StorageBucketObjectConfig.Builder extends Object implements software.amazon.jsii.Builder<StorageBucketObjectConfig>
A builder forStorageBucketObjectConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
bucket
@Stability(Stable) public StorageBucketObjectConfig.Builder bucket(String bucket)
Sets the value ofStorageBucketObjectConfig.getBucket()- Parameters:
bucket- The name of the containing bucket. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#bucket StorageBucketObject#bucket}- Returns:
this
-
name
@Stability(Stable) public StorageBucketObjectConfig.Builder name(String name)
Sets the value ofStorageBucketObjectConfig.getName()- Parameters:
name- The name of the object. If you're interpolating the name of this object, see output_name instead. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#name StorageBucketObject#name}- Returns:
this
-
cacheControl
@Stability(Stable) public StorageBucketObjectConfig.Builder cacheControl(String cacheControl)
Sets the value ofStorageBucketObjectConfig.getCacheControl()- Parameters:
cacheControl- Cache-Control directive to specify caching behavior of object data. If omitted and object is accessible to all anonymous users, the default will be public, max-age=3600 Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#cache_control StorageBucketObject#cache_control}- Returns:
this
-
content
@Stability(Stable) public StorageBucketObjectConfig.Builder content(String content)
Sets the value ofStorageBucketObjectConfig.getContent()- Parameters:
content- Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content StorageBucketObject#content}- Returns:
this
-
contentDisposition
@Stability(Stable) public StorageBucketObjectConfig.Builder contentDisposition(String contentDisposition)
Sets the value ofStorageBucketObjectConfig.getContentDisposition()- Parameters:
contentDisposition- Content-Disposition of the object data. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_disposition StorageBucketObject#content_disposition}- Returns:
this
-
contentEncoding
@Stability(Stable) public StorageBucketObjectConfig.Builder contentEncoding(String contentEncoding)
Sets the value ofStorageBucketObjectConfig.getContentEncoding()- Parameters:
contentEncoding- Content-Encoding of the object data. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_encoding StorageBucketObject#content_encoding}- Returns:
this
-
contentLanguage
@Stability(Stable) public StorageBucketObjectConfig.Builder contentLanguage(String contentLanguage)
Sets the value ofStorageBucketObjectConfig.getContentLanguage()- Parameters:
contentLanguage- Content-Language of the object data. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_language StorageBucketObject#content_language}- Returns:
this
-
contentType
@Stability(Stable) public StorageBucketObjectConfig.Builder contentType(String contentType)
Sets the value ofStorageBucketObjectConfig.getContentType()- Parameters:
contentType- Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#content_type StorageBucketObject#content_type}- Returns:
this
-
customerEncryption
@Stability(Stable) public StorageBucketObjectConfig.Builder customerEncryption(StorageBucketObjectCustomerEncryption customerEncryption)
Sets the value ofStorageBucketObjectConfig.getCustomerEncryption()- Parameters:
customerEncryption- customer_encryption block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#customer_encryption StorageBucketObject#customer_encryption}- Returns:
this
-
detectMd5Hash
@Stability(Stable) public StorageBucketObjectConfig.Builder detectMd5Hash(String detectMd5Hash)
Sets the value ofStorageBucketObjectConfig.getDetectMd5Hash()- Parameters:
detectMd5Hash- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}.- Returns:
this
-
eventBasedHold
@Stability(Stable) public StorageBucketObjectConfig.Builder eventBasedHold(Boolean eventBasedHold)
Sets the value ofStorageBucketObjectConfig.getEventBasedHold()- Parameters:
eventBasedHold- Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#event_based_hold StorageBucketObject#event_based_hold}- Returns:
this
-
eventBasedHold
@Stability(Stable) public StorageBucketObjectConfig.Builder eventBasedHold(com.hashicorp.cdktf.IResolvable eventBasedHold)
Sets the value ofStorageBucketObjectConfig.getEventBasedHold()- Parameters:
eventBasedHold- Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#event_based_hold StorageBucketObject#event_based_hold}- Returns:
this
-
id
@Stability(Stable) public StorageBucketObjectConfig.Builder id(String id)
Sets the value ofStorageBucketObjectConfig.getId()- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#id StorageBucketObject#id}. Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.- Returns:
this
-
kmsKeyName
@Stability(Stable) public StorageBucketObjectConfig.Builder kmsKeyName(String kmsKeyName)
Sets the value ofStorageBucketObjectConfig.getKmsKeyName()- Parameters:
kmsKeyName- Resource name of the Cloud KMS key that will be used to encrypt the object. Overrides the object metadata's kmsKeyName value, if any. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#kms_key_name StorageBucketObject#kms_key_name}- Returns:
this
-
metadata
@Stability(Stable) public StorageBucketObjectConfig.Builder metadata(Map<String,String> metadata)
Sets the value ofStorageBucketObjectConfig.getMetadata()- Parameters:
metadata- User-provided metadata, in key/value pairs. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#metadata StorageBucketObject#metadata}- Returns:
this
-
retention
@Stability(Stable) public StorageBucketObjectConfig.Builder retention(StorageBucketObjectRetention retention)
Sets the value ofStorageBucketObjectConfig.getRetention()- Parameters:
retention- retention block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#retention StorageBucketObject#retention}- Returns:
this
-
source
@Stability(Stable) public StorageBucketObjectConfig.Builder source(String source)
Sets the value ofStorageBucketObjectConfig.getSource()- Parameters:
source- A path to the data you want to upload. Must be defined if content is not. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#source StorageBucketObject#source}- Returns:
this
-
storageClass
@Stability(Stable) public StorageBucketObjectConfig.Builder storageClass(String storageClass)
Sets the value ofStorageBucketObjectConfig.getStorageClass()- Parameters:
storageClass- The StorageClass of the new bucket object. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE. If not provided, this defaults to the bucket's default storage class or to a standard class. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#storage_class StorageBucketObject#storage_class}- Returns:
this
-
temporaryHold
@Stability(Stable) public StorageBucketObjectConfig.Builder temporaryHold(Boolean temporaryHold)
Sets the value ofStorageBucketObjectConfig.getTemporaryHold()- Parameters:
temporaryHold- Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#temporary_hold StorageBucketObject#temporary_hold}- Returns:
this
-
temporaryHold
@Stability(Stable) public StorageBucketObjectConfig.Builder temporaryHold(com.hashicorp.cdktf.IResolvable temporaryHold)
Sets the value ofStorageBucketObjectConfig.getTemporaryHold()- Parameters:
temporaryHold- Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#temporary_hold StorageBucketObject#temporary_hold}- Returns:
this
-
timeouts
@Stability(Stable) public StorageBucketObjectConfig.Builder timeouts(StorageBucketObjectTimeouts timeouts)
Sets the value ofStorageBucketObjectConfig.getTimeouts()- Parameters:
timeouts- timeouts block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/storage_bucket_object#timeouts StorageBucketObject#timeouts}- Returns:
this
-
connection
@Stability(Experimental) public StorageBucketObjectConfig.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
connection
@Stability(Experimental) public StorageBucketObjectConfig.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public StorageBucketObjectConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public StorageBucketObjectConfig.Builder count(com.hashicorp.cdktf.TerraformCount count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
dependsOn
@Stability(Experimental) public StorageBucketObjectConfig.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
Sets the value ofTerraformMetaArguments.getDependsOn()- Parameters:
dependsOn- the value to be set.- Returns:
this
-
forEach
@Stability(Experimental) public StorageBucketObjectConfig.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
Sets the value ofTerraformMetaArguments.getForEach()- Parameters:
forEach- the value to be set.- Returns:
this
-
lifecycle
@Stability(Experimental) public StorageBucketObjectConfig.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
Sets the value ofTerraformMetaArguments.getLifecycle()- Parameters:
lifecycle- the value to be set.- Returns:
this
-
provider
@Stability(Experimental) public StorageBucketObjectConfig.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
Sets the value ofTerraformMetaArguments.getProvider()- Parameters:
provider- the value to be set.- Returns:
this
-
provisioners
@Stability(Experimental) public StorageBucketObjectConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public StorageBucketObjectConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<StorageBucketObjectConfig>- Returns:
- a new instance of
StorageBucketObjectConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-