Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.AiDocument.getProjects

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testProjects = oci.AiDocument.getProjects({
    compartmentId: compartmentId,
    displayName: projectDisplayName,
    id: projectId,
    state: projectState,
});

import pulumi
import pulumi_oci as oci

test_projects = oci.AiDocument.get_projects(compartment_id=compartment_id,
    display_name=project_display_name,
    id=project_id,
    state=project_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/AiDocument"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := AiDocument.GetProjects(ctx, &aidocument.GetProjectsArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			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.AiDocument.GetProjects.Invoke(new()
    {
        CompartmentId = compartmentId,
        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.AiDocument.AiDocumentFunctions;
import com.pulumi.oci.AiDocument.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 = AiDocumentFunctions.getProjects(GetProjectsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(projectDisplayName)
            .id(projectId)
            .state(projectState)
            .build());

    }
}

variables:
  testProjects:
    fn::invoke:
      Function: oci:AiDocument:getProjects
      Arguments:
        compartmentId: ${compartmentId}
        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,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[_aidocument.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,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_aidocument.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:AiDocument/getProjects:getProjects
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetProjectsFilter>
Id string: The filter to find the project with the given identifier.
State string: The filter to match projects with the given lifecycleState.

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetProjectsFilter
Id string: The filter to find the project with the given identifier.
State string: The filter to match projects with the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetProjectsFilter>
id String: The filter to find the project with the given identifier.
state String: The filter to match projects with the given lifecycleState.

compartmentId string: The ID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the entire display name given.
filters GetProjectsFilter[]
id string: The filter to find the project with the given identifier.
state string: The filter to match projects with the given lifecycleState.

compartment_id str: The ID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the entire display name given.
filters Sequence[aidocument.GetProjectsFilter]
id str: The filter to find the project with the given identifier.
state str: The filter to match projects with the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
id String: The filter to find the project with the given identifier.
state String: The filter to match projects with the given lifecycleState.

getProjects Result

The following output properties are available:

ProjectCollections List<GetProjectsProjectCollection>: The list of project_collection.
CompartmentId string: The compartment identifier.
DisplayName string: A human-friendly name for the project, which can be changed.
Filters List<GetProjectsFilter>
Id string: A unique identifier that is immutable after creation.
State string: The current state of the project.

ProjectCollections []GetProjectsProjectCollection: The list of project_collection.
CompartmentId string: The compartment identifier.
DisplayName string: A human-friendly name for the project, which can be changed.
Filters []GetProjectsFilter
Id string: A unique identifier that is immutable after creation.
State string: The current state of the project.

projectCollections List<GetProjectsProjectCollection>: The list of project_collection.
compartmentId String: The compartment identifier.
displayName String: A human-friendly name for the project, which can be changed.
filters List<GetProjectsFilter>
id String: A unique identifier that is immutable after creation.
state String: The current state of the project.

projectCollections GetProjectsProjectCollection[]: The list of project_collection.
compartmentId string: The compartment identifier.
displayName string: A human-friendly name for the project, which can be changed.
filters GetProjectsFilter[]
id string: A unique identifier that is immutable after creation.
state string: The current state of the project.

project_collections Sequence[aidocument.GetProjectsProjectCollection]: The list of project_collection.
compartment_id str: The compartment identifier.
display_name str: A human-friendly name for the project, which can be changed.
filters Sequence[aidocument.GetProjectsFilter]
id str: A unique identifier that is immutable after creation.
state str: The current state of the project.

projectCollections List<Property Map>: The list of project_collection.
compartmentId String: The compartment identifier.
displayName String: A human-friendly name for the project, which can be changed.
filters List<Property Map>
id String: A unique identifier that is immutable after creation.
state String: The current 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

GetProjectsProjectCollection

Items List<GetProjectsProjectCollectionItem>

Items []GetProjectsProjectCollectionItem

items List<GetProjectsProjectCollectionItem>

items GetProjectsProjectCollectionItem[]

items Sequence[aidocument.GetProjectsProjectCollectionItem]

items List<Property Map>

GetProjectsProjectCollectionItem

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
Description string: An optional description of the project.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags Dictionary<string, string>: A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
Id string: The filter to find the project with the given identifier.
LifecycleDetails string: A message describing the current state in more detail, that can provide actionable information if creation failed.
State string: The filter to match projects with the given lifecycleState.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
TimeCreated string: When the project was created, as an RFC3339 datetime string.
TimeUpdated string: When the project was updated, as an RFC3339 datetime string.

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
Description string: An optional description of the project.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags map[string]string: A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
Id string: The filter to find the project with the given identifier.
LifecycleDetails string: A message describing the current state in more detail, that can provide actionable information if creation failed.
State string: The filter to match projects with the given lifecycleState.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
TimeCreated string: When the project was created, as an RFC3339 datetime string.
TimeUpdated string: When the project was updated, as an RFC3339 datetime string.

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
description String: An optional description of the project.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String,String>: A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
id String: The filter to find the project with the given identifier.
lifecycleDetails String: A message describing the current state in more detail, that can provide actionable information if creation failed.
state String: The filter to match projects with the given lifecycleState.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
timeCreated String: When the project was created, as an RFC3339 datetime string.
timeUpdated String: When the project was updated, as an RFC3339 datetime string.

compartmentId string: The ID of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
description string: An optional description of the project.
displayName string: A filter to return only resources that match the entire display name given.
freeformTags {[key: string]: string}: A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
id string: The filter to find the project with the given identifier.
lifecycleDetails string: A message describing the current state in more detail, that can provide actionable information if creation failed.
state string: The filter to match projects with the given lifecycleState.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
timeCreated string: When the project was created, as an RFC3339 datetime string.
timeUpdated string: When the project was updated, as an RFC3339 datetime string.

compartment_id str: The ID of the compartment in which to list resources.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
description str: An optional description of the project.
display_name str: A filter to return only resources that match the entire display name given.
freeform_tags Mapping[str, str]: A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
id str: The filter to find the project with the given identifier.
lifecycle_details str: A message describing the current state in more detail, that can provide actionable information if creation failed.
state str: The filter to match projects with the given lifecycleState.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
time_created str: When the project was created, as an RFC3339 datetime string.
time_updated str: When the project was updated, as an RFC3339 datetime string.

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}
description String: An optional description of the project.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String>: A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {"bar-key": "value"}
id String: The filter to find the project with the given identifier.
lifecycleDetails String: A message describing the current state in more detail, that can provide actionable information if creation failed.
state String: The filter to match projects with the given lifecycleState.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
timeCreated String: When the project was created, as an RFC3339 datetime string.
timeUpdated String: When the project was updated, as an RFC3339 datetime string.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.AiDocument.getProjects

On this page

On this page

Example Usage

Using getProjects

getProjects Result

Supporting Types

GetProjectsFilter

GetProjectsProjectCollection

GetProjectsProjectCollectionItem

Package Details

On this page

On this page