Package com.hashicorp.cdktf.providers.google.data_pipeline_pipeline

Class DataPipelinePipeline.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static DataPipelinePipeline.Builder create​(software.constructs.Construct scope,
                                                  String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of DataPipelinePipeline.Builder.

      • connection

        @Stability(Experimental)
public DataPipelinePipeline.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public DataPipelinePipeline.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public DataPipelinePipeline.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public DataPipelinePipeline.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public DataPipelinePipeline.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public DataPipelinePipeline.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public DataPipelinePipeline.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public DataPipelinePipeline.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public DataPipelinePipeline.Builder name​(String name)
        "The pipeline name.

        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}

        Parameters:
        name - "The pipeline name. This parameter is required.
        Returns:
        this

      • state

        @Stability(Stable)
public DataPipelinePipeline.Builder state​(String state)
        The state of the pipeline.

        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}

        Parameters:
        state - The state of the pipeline. This parameter is required.
        Returns:
        this

      • type

        @Stability(Stable)
public DataPipelinePipeline.Builder type​(String type)
        The type of the pipeline.

        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}

        Parameters:
        type - The type of the pipeline. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public DataPipelinePipeline.Builder displayName​(String 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}

        Parameters:
        displayName - The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public DataPipelinePipeline.Builder id​(String 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.

        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}. This parameter is required.
        Returns:
        this

      • pipelineSources

        @Stability(Stable)
public DataPipelinePipeline.Builder pipelineSources​(Map<String,​String> 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}

        Parameters:
        pipelineSources - The sources of the pipeline (for example, Dataplex). This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public DataPipelinePipeline.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/data_pipeline_pipeline#project DataPipelinePipeline#project}.

        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}. This parameter is required.
        Returns:
        this

      • region

        @Stability(Stable)
public DataPipelinePipeline.Builder region​(String 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}

        Parameters:
        region - A reference to the region. This parameter is required.
        Returns:
        this

      • scheduleInfo

        @Stability(Stable)
public DataPipelinePipeline.Builder scheduleInfo​(DataPipelinePipelineScheduleInfo 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}

        Parameters:
        scheduleInfo - schedule_info block. This parameter is required.
        Returns:
        this

      • schedulerServiceAccountEmail

        @Stability(Stable)
public DataPipelinePipeline.Builder schedulerServiceAccountEmail​(String 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}

        Parameters:
        schedulerServiceAccountEmail - Optional. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public DataPipelinePipeline.Builder timeouts​(DataPipelinePipelineTimeouts 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}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • workload

        @Stability(Stable)
public DataPipelinePipeline.Builder workload​(DataPipelinePipelineWorkload 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}

        Parameters:
        workload - workload block. This parameter is required.
        Returns:
        this