Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getDataLakePipelineRuns
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getDataLakePipelineRuns

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.getDataLakePipelineRun describe Data Lake Pipeline Runs.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.DataLakePipeline;
import com.pulumi.mongodbatlas.DataLakePipelineArgs;
import com.pulumi.mongodbatlas.inputs.DataLakePipelineSinkArgs;
import com.pulumi.mongodbatlas.inputs.DataLakePipelineSourceArgs;
import com.pulumi.mongodbatlas.inputs.DataLakePipelineTransformationArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetDataLakePipelineRunsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pipeline = new DataLakePipeline("pipeline", DataLakePipelineArgs.builder()        
            .projectId(mongodbatlas_project.projectTest().project_id())
            .sink(DataLakePipelineSinkArgs.builder()
                .type("DLS")
                .partitionFields(DataLakePipelineSinkPartitionFieldArgs.builder()
                    .name("access")
                    .order(0)
                    .build())
                .build())
            .source(DataLakePipelineSourceArgs.builder()
                .type("ON_DEMAND_CPS")
                .clusterName(mongodbatlas_cluster.clusterTest().name())
                .databaseName("sample_airbnb")
                .collectionName("listingsAndReviews")
                .build())
            .transformations(            
                DataLakePipelineTransformationArgs.builder()
                    .field("test")
                    .type("EXCLUDE")
                    .build(),
                DataLakePipelineTransformationArgs.builder()
                    .field("test22")
                    .type("EXCLUDE")
                    .build())
            .build());

        final var test = MongodbatlasFunctions.getDataLakePipelineRuns(GetDataLakePipelineRunsArgs.builder()
            .projectId(mongodbatlas_project.projectTest().project_id())
            .pipelineName(pipeline.name())
            .build());

    }
}

    resources:
  pipeline:
    type: mongodbatlas:DataLakePipeline
    properties:
      # assuming we've already setup project and cluster in another block
      projectId: ${mongodbatlas_project.projectTest.project_id}
      sink:
        type: DLS
        partitionFields:
          - name: access
            order: 0
      source:
        type: ON_DEMAND_CPS
        clusterName: ${mongodbatlas_cluster.clusterTest.name}
        databaseName: sample_airbnb
        collectionName: listingsAndReviews
      transformations:
        - field: test
          type: EXCLUDE
        - field: test22
          type: EXCLUDE
variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getDataLakePipelineRuns
      Arguments:
        projectId: ${mongodbatlas_project.projectTest.project_id}
        pipelineName: ${pipeline.name}

    Using getDataLakePipelineRuns

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataLakePipelineRuns(args: GetDataLakePipelineRunsArgs, opts?: InvokeOptions): Promise<GetDataLakePipelineRunsResult>
function getDataLakePipelineRunsOutput(args: GetDataLakePipelineRunsOutputArgs, opts?: InvokeOptions): Output<GetDataLakePipelineRunsResult>
    def get_data_lake_pipeline_runs(pipeline_name: Optional[str] = None,
                                project_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetDataLakePipelineRunsResult
def get_data_lake_pipeline_runs_output(pipeline_name: Optional[pulumi.Input[str]] = None,
                                project_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetDataLakePipelineRunsResult]
    func LookupDataLakePipelineRuns(ctx *Context, args *LookupDataLakePipelineRunsArgs, opts ...InvokeOption) (*LookupDataLakePipelineRunsResult, error)
func LookupDataLakePipelineRunsOutput(ctx *Context, args *LookupDataLakePipelineRunsOutputArgs, opts ...InvokeOption) LookupDataLakePipelineRunsResultOutput

    > Note: This function is named LookupDataLakePipelineRuns in the Go SDK.

    public static class GetDataLakePipelineRuns 
{
    public static Task<GetDataLakePipelineRunsResult> InvokeAsync(GetDataLakePipelineRunsArgs args, InvokeOptions? opts = null)
    public static Output<GetDataLakePipelineRunsResult> Invoke(GetDataLakePipelineRunsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDataLakePipelineRunsResult> getDataLakePipelineRuns(GetDataLakePipelineRunsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: mongodbatlas:index/getDataLakePipelineRuns:getDataLakePipelineRuns
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PipelineName string
    Human-readable label that identifies the Data Lake Pipeline.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    PipelineName string
    Human-readable label that identifies the Data Lake Pipeline.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    pipelineName String
    Human-readable label that identifies the Data Lake Pipeline.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    pipelineName string
    Human-readable label that identifies the Data Lake Pipeline.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    pipeline_name str
    Human-readable label that identifies the Data Lake Pipeline.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    pipelineName String
    Human-readable label that identifies the Data Lake Pipeline.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.

    getDataLakePipelineRuns Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PipelineName string
    ProjectId string
    Results List<GetDataLakePipelineRunsResult>
    A list where each represents a Data Lake Pipeline Run.
    Id string
    The provider-assigned unique ID for this managed resource.
    PipelineName string
    ProjectId string
    Results []GetDataLakePipelineRunsResult
    A list where each represents a Data Lake Pipeline Run.
    id String
    The provider-assigned unique ID for this managed resource.
    pipelineName String
    projectId String
    results List<GetDataLakePipelineRunsResult>
    A list where each represents a Data Lake Pipeline Run.
    id string
    The provider-assigned unique ID for this managed resource.
    pipelineName string
    projectId string
    results GetDataLakePipelineRunsResult[]
    A list where each represents a Data Lake Pipeline Run.
    id str
    The provider-assigned unique ID for this managed resource.
    pipeline_name str
    project_id str
    results Sequence[GetDataLakePipelineRunsResult]
    A list where each represents a Data Lake Pipeline Run.
    id String
    The provider-assigned unique ID for this managed resource.
    pipelineName String
    projectId String
    results List<Property Map>
    A list where each represents a Data Lake Pipeline Run.

    Supporting Types

    GetDataLakePipelineRunsResult

    BackupFrequencyType string
    Backup schedule interval of the Data Lake Pipeline.
    CreatedDate string
    Timestamp that indicates when the pipeline run was created.
    Id string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    LastUpdatedDate string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    Phase string
    Processing phase of the Data Lake Pipeline.
    PipelineId string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
    PipelineRunId string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    SnapshotId string
    Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
    State string
    State of the pipeline run.
    Stats List<GetDataLakePipelineRunsResultStat>
    Runtime statistics for this Data Lake Pipeline run.
    BackupFrequencyType string
    Backup schedule interval of the Data Lake Pipeline.
    CreatedDate string
    Timestamp that indicates when the pipeline run was created.
    Id string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    LastUpdatedDate string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    Phase string
    Processing phase of the Data Lake Pipeline.
    PipelineId string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
    PipelineRunId string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    SnapshotId string
    Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
    State string
    State of the pipeline run.
    Stats []GetDataLakePipelineRunsResultStat
    Runtime statistics for this Data Lake Pipeline run.
    backupFrequencyType String
    Backup schedule interval of the Data Lake Pipeline.
    createdDate String
    Timestamp that indicates when the pipeline run was created.
    id String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    lastUpdatedDate String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    phase String
    Processing phase of the Data Lake Pipeline.
    pipelineId String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
    pipelineRunId String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    snapshotId String
    Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
    state String
    State of the pipeline run.
    stats List<GetDataLakePipelineRunsResultStat>
    Runtime statistics for this Data Lake Pipeline run.
    backupFrequencyType string
    Backup schedule interval of the Data Lake Pipeline.
    createdDate string
    Timestamp that indicates when the pipeline run was created.
    id string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    lastUpdatedDate string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    phase string
    Processing phase of the Data Lake Pipeline.
    pipelineId string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
    pipelineRunId string
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    snapshotId string
    Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
    state string
    State of the pipeline run.
    stats GetDataLakePipelineRunsResultStat[]
    Runtime statistics for this Data Lake Pipeline run.
    backup_frequency_type str
    Backup schedule interval of the Data Lake Pipeline.
    created_date str
    Timestamp that indicates when the pipeline run was created.
    id str
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    last_updated_date str
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    phase str
    Processing phase of the Data Lake Pipeline.
    pipeline_id str
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
    pipeline_run_id str
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    snapshot_id str
    Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
    state str
    State of the pipeline run.
    stats Sequence[GetDataLakePipelineRunsResultStat]
    Runtime statistics for this Data Lake Pipeline run.
    backupFrequencyType String
    Backup schedule interval of the Data Lake Pipeline.
    createdDate String
    Timestamp that indicates when the pipeline run was created.
    id String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    lastUpdatedDate String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    phase String
    Processing phase of the Data Lake Pipeline.
    pipelineId String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
    pipelineRunId String
    Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
    snapshotId String
    Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
    state String
    State of the pipeline run.
    stats List<Property Map>
    Runtime statistics for this Data Lake Pipeline run.

    GetDataLakePipelineRunsResultStat

    BytesExported int
    Total data size in bytes exported for this pipeline run.
    NumDocs int
    Number of docs ingested for a this pipeline run.
    BytesExported int
    Total data size in bytes exported for this pipeline run.
    NumDocs int
    Number of docs ingested for a this pipeline run.
    bytesExported Integer
    Total data size in bytes exported for this pipeline run.
    numDocs Integer
    Number of docs ingested for a this pipeline run.
    bytesExported number
    Total data size in bytes exported for this pipeline run.
    numDocs number
    Number of docs ingested for a this pipeline run.
    bytes_exported int
    Total data size in bytes exported for this pipeline run.
    num_docs int
    Number of docs ingested for a this pipeline run.
    bytesExported Number
    Total data size in bytes exported for this pipeline run.
    numDocs Number
    Number of docs ingested for a this pipeline run.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas