Class CloudSchedulerJobConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.cloud_scheduler_job.CloudSchedulerJobConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<CloudSchedulerJobConfig>
- Enclosing interface:
- CloudSchedulerJobConfig
@Stability(Stable) public static final class CloudSchedulerJobConfig.Builder extends Object implements software.amazon.jsii.Builder<CloudSchedulerJobConfig>
A builder forCloudSchedulerJobConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
name
@Stability(Stable) public CloudSchedulerJobConfig.Builder name(String name)
Sets the value ofCloudSchedulerJobConfig.getName()- Parameters:
name- The name of the job. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#name CloudSchedulerJob#name}- Returns:
this
-
appEngineHttpTarget
@Stability(Stable) public CloudSchedulerJobConfig.Builder appEngineHttpTarget(CloudSchedulerJobAppEngineHttpTarget appEngineHttpTarget)
Sets the value ofCloudSchedulerJobConfig.getAppEngineHttpTarget()- Parameters:
appEngineHttpTarget- app_engine_http_target block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#app_engine_http_target CloudSchedulerJob#app_engine_http_target}- Returns:
this
-
attemptDeadline
@Stability(Stable) public CloudSchedulerJobConfig.Builder attemptDeadline(String attemptDeadline)
Sets the value ofCloudSchedulerJobConfig.getAttemptDeadline()- Parameters:
attemptDeadline- The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s" Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#attempt_deadline CloudSchedulerJob#attempt_deadline}- Returns:
this
-
description
@Stability(Stable) public CloudSchedulerJobConfig.Builder description(String description)
Sets the value ofCloudSchedulerJobConfig.getDescription()- Parameters:
description- A human-readable description for the job. This string must not contain more than 500 characters. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#description CloudSchedulerJob#description}- Returns:
this
-
httpTarget
@Stability(Stable) public CloudSchedulerJobConfig.Builder httpTarget(CloudSchedulerJobHttpTarget httpTarget)
Sets the value ofCloudSchedulerJobConfig.getHttpTarget()- Parameters:
httpTarget- http_target block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#http_target CloudSchedulerJob#http_target}- Returns:
this
-
id
@Stability(Stable) public CloudSchedulerJobConfig.Builder id(String id)
Sets the value ofCloudSchedulerJobConfig.getId()- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#id CloudSchedulerJob#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
-
paused
@Stability(Stable) public CloudSchedulerJobConfig.Builder paused(Boolean paused)
Sets the value ofCloudSchedulerJobConfig.getPaused()- Parameters:
paused- Sets the job to a paused state. Jobs default to being enabled when this property is not set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#paused CloudSchedulerJob#paused}- Returns:
this
-
paused
@Stability(Stable) public CloudSchedulerJobConfig.Builder paused(com.hashicorp.cdktf.IResolvable paused)
Sets the value ofCloudSchedulerJobConfig.getPaused()- Parameters:
paused- Sets the job to a paused state. Jobs default to being enabled when this property is not set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#paused CloudSchedulerJob#paused}- Returns:
this
-
project
@Stability(Stable) public CloudSchedulerJobConfig.Builder project(String project)
Sets the value ofCloudSchedulerJobConfig.getProject()- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#project CloudSchedulerJob#project}.- Returns:
this
-
pubsubTarget
@Stability(Stable) public CloudSchedulerJobConfig.Builder pubsubTarget(CloudSchedulerJobPubsubTarget pubsubTarget)
Sets the value ofCloudSchedulerJobConfig.getPubsubTarget()- Parameters:
pubsubTarget- pubsub_target block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#pubsub_target CloudSchedulerJob#pubsub_target}- Returns:
this
-
region
@Stability(Stable) public CloudSchedulerJobConfig.Builder region(String region)
Sets the value ofCloudSchedulerJobConfig.getRegion()- Parameters:
region- Region where the scheduler job resides. If it is not provided, Terraform will use the provider default. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#region CloudSchedulerJob#region}- Returns:
this
-
retryConfig
@Stability(Stable) public CloudSchedulerJobConfig.Builder retryConfig(CloudSchedulerJobRetryConfig retryConfig)
Sets the value ofCloudSchedulerJobConfig.getRetryConfig()- Parameters:
retryConfig- retry_config block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#retry_config CloudSchedulerJob#retry_config}- Returns:
this
-
schedule
@Stability(Stable) public CloudSchedulerJobConfig.Builder schedule(String schedule)
Sets the value ofCloudSchedulerJobConfig.getSchedule()- Parameters:
schedule- Describes the schedule on which the job will be executed. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#schedule CloudSchedulerJob#schedule}- Returns:
this
-
timeouts
@Stability(Stable) public CloudSchedulerJobConfig.Builder timeouts(CloudSchedulerJobTimeouts timeouts)
Sets the value ofCloudSchedulerJobConfig.getTimeouts()- Parameters:
timeouts- timeouts block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#timeouts CloudSchedulerJob#timeouts}- Returns:
this
-
timeZone
@Stability(Stable) public CloudSchedulerJobConfig.Builder timeZone(String timeZone)
Sets the value ofCloudSchedulerJobConfig.getTimeZone()- Parameters:
timeZone- Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#time_zone CloudSchedulerJob#time_zone}- Returns:
this
-
connection
@Stability(Experimental) public CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.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 CloudSchedulerJobConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public CloudSchedulerJobConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CloudSchedulerJobConfig>- Returns:
- a new instance of
CloudSchedulerJobConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-