Class DataPipelinePipelineConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.data_pipeline_pipeline.DataPipelinePipelineConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DataPipelinePipelineConfig>
- Enclosing interface:
- DataPipelinePipelineConfig
@Stability(Stable) public static final class DataPipelinePipelineConfig.Builder extends Object implements software.amazon.jsii.Builder<DataPipelinePipelineConfig>
A builder forDataPipelinePipelineConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
name
@Stability(Stable) public DataPipelinePipelineConfig.Builder name(String name)
Sets the value ofDataPipelinePipelineConfig.getName()- Parameters:
name- "The pipeline name. This parameter is required. For example': 'projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID." "- PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects." "LOCATION_ID is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions." "PIPELINE_ID is the ID of the pipeline. Must be unique for the selected project and location." Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#name DataPipelinePipeline#name}- Returns:
this
-
state
@Stability(Stable) public DataPipelinePipelineConfig.Builder state(String state)
Sets the value ofDataPipelinePipelineConfig.getState()- Parameters:
state- The state of the pipeline. This parameter is required. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through pipelines.patch requests. https://cloud.google.com/dataflow/docs/reference/data-pipelines/rest/v1/projects.locations.pipelines#state Possible values: ["STATE_UNSPECIFIED", "STATE_RESUMING", "STATE_ACTIVE", "STATE_STOPPING", "STATE_ARCHIVED", "STATE_PAUSED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#state DataPipelinePipeline#state}- Returns:
this
-
type
@Stability(Stable) public DataPipelinePipelineConfig.Builder type(String type)
Sets the value ofDataPipelinePipelineConfig.getType()- Parameters:
type- The type of the pipeline. This parameter is required. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. https://cloud.google.com/dataflow/docs/reference/data-pipelines/rest/v1/projects.locations.pipelines#pipelinetype Possible values: ["PIPELINE_TYPE_UNSPECIFIED", "PIPELINE_TYPE_BATCH", "PIPELINE_TYPE_STREAMING"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#type DataPipelinePipeline#type}- Returns:
this
-
displayName
@Stability(Stable) public DataPipelinePipelineConfig.Builder displayName(String displayName)
Sets the value ofDataPipelinePipelineConfig.getDisplayName()- Parameters:
displayName- The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#display_name DataPipelinePipeline#display_name}- Returns:
this
-
id
@Stability(Stable) public DataPipelinePipelineConfig.Builder id(String id)
Sets the value ofDataPipelinePipelineConfig.getId()- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#id DataPipelinePipeline#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
-
pipelineSources
@Stability(Stable) public DataPipelinePipelineConfig.Builder pipelineSources(Map<String,String> pipelineSources)
Sets the value ofDataPipelinePipelineConfig.getPipelineSources()- Parameters:
pipelineSources- The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#pipeline_sources DataPipelinePipeline#pipeline_sources}- Returns:
this
-
project
@Stability(Stable) public DataPipelinePipelineConfig.Builder project(String project)
Sets the value ofDataPipelinePipelineConfig.getProject()- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#project DataPipelinePipeline#project}.- Returns:
this
-
region
@Stability(Stable) public DataPipelinePipelineConfig.Builder region(String region)
Sets the value ofDataPipelinePipelineConfig.getRegion()- Parameters:
region- A reference to the region. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#region DataPipelinePipeline#region}- Returns:
this
-
scheduleInfo
@Stability(Stable) public DataPipelinePipelineConfig.Builder scheduleInfo(DataPipelinePipelineScheduleInfo scheduleInfo)
Sets the value ofDataPipelinePipelineConfig.getScheduleInfo()- Parameters:
scheduleInfo- schedule_info block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#schedule_info DataPipelinePipeline#schedule_info}- Returns:
this
-
schedulerServiceAccountEmail
@Stability(Stable) public DataPipelinePipelineConfig.Builder schedulerServiceAccountEmail(String schedulerServiceAccountEmail)
Sets the value ofDataPipelinePipelineConfig.getSchedulerServiceAccountEmail()- Parameters:
schedulerServiceAccountEmail- Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#scheduler_service_account_email DataPipelinePipeline#scheduler_service_account_email}- Returns:
this
-
timeouts
@Stability(Stable) public DataPipelinePipelineConfig.Builder timeouts(DataPipelinePipelineTimeouts timeouts)
Sets the value ofDataPipelinePipelineConfig.getTimeouts()- Parameters:
timeouts- timeouts block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#timeouts DataPipelinePipeline#timeouts}- Returns:
this
-
workload
@Stability(Stable) public DataPipelinePipelineConfig.Builder workload(DataPipelinePipelineWorkload workload)
Sets the value ofDataPipelinePipelineConfig.getWorkload()- Parameters:
workload- workload block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#workload DataPipelinePipeline#workload}- Returns:
this
-
connection
@Stability(Experimental) public DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.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 DataPipelinePipelineConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public DataPipelinePipelineConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<DataPipelinePipelineConfig>- Returns:
- a new instance of
DataPipelinePipelineConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-