Oracle Cloud Infrastructure v2.17.0, Nov 15 24

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

oci.AiLanguage.getProjects

Explore with Pulumi AI

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

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.oci.AiLanguage.AiLanguageFunctions;
import com.pulumi.oci.AiLanguage.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 = AiLanguageFunctions.getProjects(GetProjectsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(projectDisplayName)
            .projectId(testProject.id())
            .state(projectState)
            .build());

    }
}

variables:
  testProjects:
    fn::invoke:
      Function: oci:AiLanguage:getProjects
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${projectDisplayName}
        projectId: ${testProject.id}
        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[_ailanguage.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[_ailanguage.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:AiLanguage/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: Unique identifier OCID of the project
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

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: Unique identifier OCID of the project
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

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: Unique identifier OCID of the project
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

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: Unique identifier OCID of the project
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

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[ailanguage.GetProjectsFilter]
id str: Unique identifier OCID of the project
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

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: Unique identifier OCID of the project
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 for the project's compartment.
ProjectCollections List<GetProjectsProjectCollection>: The list of project_collection.
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: Unique identifier OCID of the project
State string: The state of the project.

CompartmentId string: The OCID for the project's compartment.
ProjectCollections []GetProjectsProjectCollection: The list of project_collection.
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: Unique identifier OCID of the project
State string: The state of the project.

compartmentId String: The OCID for the project's compartment.
projectCollections List<GetProjectsProjectCollection>: The list of project_collection.
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: Unique identifier OCID of the project
state String: The state of the project.

compartmentId string: The OCID for the project's compartment.
projectCollections GetProjectsProjectCollection[]: The list of project_collection.
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: Unique identifier OCID of the project
state string: The state of the project.

compartment_id str: The OCID for the project's compartment.
project_collections Sequence[ailanguage.GetProjectsProjectCollection]: The list of project_collection.
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[ailanguage.GetProjectsFilter]
id str: Unique identifier OCID of the project
state str: The state of the project.

compartmentId String: The OCID for the project's compartment.
projectCollections List<Property Map>: The list of project_collection.
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: Unique identifier 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

GetProjectsProjectCollection

Items List<GetProjectsProjectCollectionItem>

Items []GetProjectsProjectCollectionItem

items List<GetProjectsProjectCollectionItem>

items GetProjectsProjectCollectionItem[]

items Sequence[ailanguage.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. Example: {"foo-namespace.bar-key": "value"}
Description string: A short description of a project.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier OCID of the project
LifecycleDetails string: A message describing the current state in more detail.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
SystemTags Dictionary<string, string>: 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.
TimeUpdated string: The date and time the resource was updated in the timestamp format defined by RFC3339.

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. Example: {"foo-namespace.bar-key": "value"}
Description string: A short description of a project.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier OCID of the project
LifecycleDetails string: A message describing the current state in more detail.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
SystemTags map[string]string: 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.
TimeUpdated string: The date and time the resource was updated in the timestamp format defined by RFC3339.

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. Example: {"foo-namespace.bar-key": "value"}
description String: A short description of a project.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier OCID of the project
lifecycleDetails String: A message describing the current state in more detail.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags Map<String,String>: 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.
timeUpdated String: The date and time the resource was updated in the timestamp format defined by RFC3339.

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. Example: {"foo-namespace.bar-key": "value"}
description string: A short description of a project.
displayName string: A filter to return only resources that match the entire display name given.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier OCID of the project
lifecycleDetails string: A message describing the current state in more detail.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags {[key: string]: string}: 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.
timeUpdated string: The date and time the resource was updated in the timestamp format defined by RFC3339.

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. Example: {"foo-namespace.bar-key": "value"}
description str: A short description of a project.
display_name str: A filter to return only resources that match the entire display name given.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier OCID of the project
lifecycle_details str: A message describing the current state in more detail.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
system_tags Mapping[str, str]: 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.
time_updated str: The date and time the resource was updated in the timestamp format defined by RFC3339.

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. Example: {"foo-namespace.bar-key": "value"}
description String: A short description of a project.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier OCID of the project
lifecycleDetails String: A message describing the current state in more detail.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags Map<String>: 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.
timeUpdated String: The date and time the resource was updated in the timestamp format defined by RFC3339.

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.AiLanguage.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