1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataScience
  5. getProjects
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.DataScience.getProjects

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This data source provides the list of Projects in Oracle Cloud Infrastructure Data Science service.

    Lists projects in the specified compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testProjects = oci.DataScience.getProjects({
        compartmentId: compartmentId,
        createdBy: projectCreatedBy,
        displayName: projectDisplayName,
        id: projectId,
        state: projectState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_projects = oci.DataScience.get_projects(compartment_id=compartment_id,
        created_by=project_created_by,
        display_name=project_display_name,
        id=project_id,
        state=project_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DataScience"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DataScience.GetProjects(ctx, &datascience.GetProjectsArgs{
    			CompartmentId: compartmentId,
    			CreatedBy:     pulumi.StringRef(projectCreatedBy),
    			DisplayName:   pulumi.StringRef(projectDisplayName),
    			Id:            pulumi.StringRef(projectId),
    			State:         pulumi.StringRef(projectState),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testProjects = Oci.DataScience.GetProjects.Invoke(new()
        {
            CompartmentId = compartmentId,
            CreatedBy = projectCreatedBy,
            DisplayName = projectDisplayName,
            Id = projectId,
            State = projectState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DataScience.DataScienceFunctions;
    import com.pulumi.oci.DataScience.inputs.GetProjectsArgs;
    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) {
            final var testProjects = DataScienceFunctions.getProjects(GetProjectsArgs.builder()
                .compartmentId(compartmentId)
                .createdBy(projectCreatedBy)
                .displayName(projectDisplayName)
                .id(projectId)
                .state(projectState)
                .build());
    
        }
    }
    
    variables:
      testProjects:
        fn::invoke:
          Function: oci:DataScience:getProjects
          Arguments:
            compartmentId: ${compartmentId}
            createdBy: ${projectCreatedBy}
            displayName: ${projectDisplayName}
            id: ${projectId}
            state: ${projectState}
    

    Using getProjects

    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 getProjects(args: GetProjectsArgs, opts?: InvokeOptions): Promise<GetProjectsResult>
    function getProjectsOutput(args: GetProjectsOutputArgs, opts?: InvokeOptions): Output<GetProjectsResult>
    def get_projects(compartment_id: Optional[str] = None,
                     created_by: Optional[str] = None,
                     display_name: Optional[str] = None,
                     filters: Optional[Sequence[_datascience.GetProjectsFilter]] = None,
                     id: Optional[str] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetProjectsResult
    def get_projects_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     created_by: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datascience.GetProjectsFilterArgs]]]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetProjectsResult]
    func GetProjects(ctx *Context, args *GetProjectsArgs, opts ...InvokeOption) (*GetProjectsResult, error)
    func GetProjectsOutput(ctx *Context, args *GetProjectsOutputArgs, opts ...InvokeOption) GetProjectsResultOutput

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

    public static class GetProjects 
    {
        public static Task<GetProjectsResult> InvokeAsync(GetProjectsArgs args, InvokeOptions? opts = null)
        public static Output<GetProjectsResult> Invoke(GetProjectsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataScience/getProjects:getProjects
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    Filter results by the OCID of the compartment.
    CreatedBy string
    Filter results by the OCID of the user who created the resource.
    DisplayName string
    Filter results by its user-friendly name.
    Filters List<GetProjectsFilter>
    Id string
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    CompartmentId string
    Filter results by the OCID of the compartment.
    CreatedBy string
    Filter results by the OCID of the user who created the resource.
    DisplayName string
    Filter results by its user-friendly name.
    Filters []GetProjectsFilter
    Id string
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    compartmentId String
    Filter results by the OCID of the compartment.
    createdBy String
    Filter results by the OCID of the user who created the resource.
    displayName String
    Filter results by its user-friendly name.
    filters List<GetProjectsFilter>
    id String
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    compartmentId string
    Filter results by the OCID of the compartment.
    createdBy string
    Filter results by the OCID of the user who created the resource.
    displayName string
    Filter results by its user-friendly name.
    filters GetProjectsFilter[]
    id string
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    compartment_id str
    Filter results by the OCID of the compartment.
    created_by str
    Filter results by the OCID of the user who created the resource.
    display_name str
    Filter results by its user-friendly name.
    filters Sequence[datascience.GetProjectsFilter]
    id str
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state str
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    compartmentId String
    Filter results by the OCID of the compartment.
    createdBy String
    Filter results by the OCID of the user who created the resource.
    displayName String
    Filter results by its user-friendly name.
    filters List<Property Map>
    id String
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

    getProjects Result

    The following output properties are available:

    CompartmentId string
    The OCID of the project's compartment.
    Projects List<GetProjectsProject>
    The list of projects.
    CreatedBy string
    The OCID of the user who created this project.
    DisplayName string
    A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
    Filters List<GetProjectsFilter>
    Id string
    The OCID of the project.
    State string
    The state of the project.
    CompartmentId string
    The OCID of the project's compartment.
    Projects []GetProjectsProject
    The list of projects.
    CreatedBy string
    The OCID of the user who created this project.
    DisplayName string
    A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
    Filters []GetProjectsFilter
    Id string
    The OCID of the project.
    State string
    The state of the project.
    compartmentId String
    The OCID of the project's compartment.
    projects List<GetProjectsProject>
    The list of projects.
    createdBy String
    The OCID of the user who created this project.
    displayName String
    A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
    filters List<GetProjectsFilter>
    id String
    The OCID of the project.
    state String
    The state of the project.
    compartmentId string
    The OCID of the project's compartment.
    projects GetProjectsProject[]
    The list of projects.
    createdBy string
    The OCID of the user who created this project.
    displayName string
    A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
    filters GetProjectsFilter[]
    id string
    The OCID of the project.
    state string
    The state of the project.
    compartment_id str
    The OCID of the project's compartment.
    projects Sequence[datascience.GetProjectsProject]
    The list of projects.
    created_by str
    The OCID of the user who created this project.
    display_name str
    A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
    filters Sequence[datascience.GetProjectsFilter]
    id str
    The OCID of the project.
    state str
    The state of the project.
    compartmentId String
    The OCID of the project's compartment.
    projects List<Property Map>
    The list of projects.
    createdBy String
    The OCID of the user who created this project.
    displayName String
    A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
    filters List<Property Map>
    id String
    The OCID of the project.
    state String
    The state of the project.

    Supporting Types

    GetProjectsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetProjectsProject

    CompartmentId string
    Filter results by the OCID of the compartment.
    CreatedBy string
    Filter results by the OCID of the user who created the resource.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A short description of the project.
    DisplayName string
    Filter results by its user-friendly name.
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    Id string
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
    CompartmentId string
    Filter results by the OCID of the compartment.
    CreatedBy string
    Filter results by the OCID of the user who created the resource.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A short description of the project.
    DisplayName string
    Filter results by its user-friendly name.
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    Id string
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
    compartmentId String
    Filter results by the OCID of the compartment.
    createdBy String
    Filter results by the OCID of the user who created the resource.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A short description of the project.
    displayName String
    Filter results by its user-friendly name.
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    id String
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
    compartmentId string
    Filter results by the OCID of the compartment.
    createdBy string
    Filter results by the OCID of the user who created the resource.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    A short description of the project.
    displayName string
    Filter results by its user-friendly name.
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    id string
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
    compartment_id str
    Filter results by the OCID of the compartment.
    created_by str
    Filter results by the OCID of the user who created the resource.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    A short description of the project.
    display_name str
    Filter results by its user-friendly name.
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    id str
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state str
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
    compartmentId String
    Filter results by the OCID of the compartment.
    createdBy String
    Filter results by the OCID of the user who created the resource.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A short description of the project.
    displayName String
    Filter results by its user-friendly name.
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    id String
    Filter results by OCID. Must be an OCID of the correct type for the resource type.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi