Oracle Cloud Infrastructure v2.11.0, Sep 19 24

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.GenerativeAi.getEndpoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

Example Usage

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

const testEndpoints = oci.GenerativeAi.getEndpoints({
    compartmentId: compartmentId,
    displayName: endpointDisplayName,
    id: endpointId,
    state: endpointState,
});

import pulumi
import pulumi_oci as oci

test_endpoints = oci.GenerativeAi.get_endpoints(compartment_id=compartment_id,
    display_name=endpoint_display_name,
    id=endpoint_id,
    state=endpoint_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GenerativeAi.GetEndpoints(ctx, &generativeai.GetEndpointsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(endpointDisplayName),
			Id:            pulumi.StringRef(endpointId),
			State:         pulumi.StringRef(endpointState),
		}, 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 testEndpoints = Oci.GenerativeAi.GetEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = endpointDisplayName,
        Id = endpointId,
        State = endpointState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetEndpointsArgs;
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 testEndpoints = GenerativeAiFunctions.getEndpoints(GetEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(endpointDisplayName)
            .id(endpointId)
            .state(endpointState)
            .build());

    }
}

variables:
  testEndpoints:
    fn::invoke:
      Function: oci:GenerativeAi:getEndpoints
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${endpointDisplayName}
        id: ${endpointId}
        state: ${endpointState}

Using getEndpoints

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 getEndpoints(args: GetEndpointsArgs, opts?: InvokeOptions): Promise<GetEndpointsResult>
function getEndpointsOutput(args: GetEndpointsOutputArgs, opts?: InvokeOptions): Output<GetEndpointsResult>

def get_endpoints(compartment_id: Optional[str] = None,
                  display_name: Optional[str] = None,
                  filters: Optional[Sequence[_generativeai.GetEndpointsFilter]] = None,
                  id: Optional[str] = None,
                  state: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetEndpointsResult
def get_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                  display_name: Optional[pulumi.Input[str]] = None,
                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_generativeai.GetEndpointsFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  state: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetEndpointsResult]

func GetEndpoints(ctx *Context, args *GetEndpointsArgs, opts ...InvokeOption) (*GetEndpointsResult, error)
func GetEndpointsOutput(ctx *Context, args *GetEndpointsOutputArgs, opts ...InvokeOption) GetEndpointsResultOutput

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

public static class GetEndpoints 
{
    public static Task<GetEndpointsResult> InvokeAsync(GetEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointsResult> Invoke(GetEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:GenerativeAi/getEndpoints:getEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetEndpointsFilter>
Id string: The OCID of the endpoint.
State string: A filter to return only resources that their lifecycle state matches the given lifecycle state.

CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetEndpointsFilter
Id string: The OCID of the endpoint.
State string: A filter to return only resources that their lifecycle state matches the given lifecycle state.

compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetEndpointsFilter>
id String: The OCID of the endpoint.
state String: A filter to return only resources that their lifecycle state matches the given lifecycle state.

compartmentId string: The OCID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetEndpointsFilter[]
id string: The OCID of the endpoint.
state string: A filter to return only resources that their lifecycle state matches the given lifecycle state.

compartment_id str: The OCID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[generativeai.GetEndpointsFilter]
id str: The OCID of the endpoint.
state str: A filter to return only resources that their lifecycle state matches the given lifecycle state.

compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
id String: The OCID of the endpoint.
state String: A filter to return only resources that their lifecycle state matches the given lifecycle state.

getEndpoints Result

The following output properties are available:

CompartmentId string
EndpointCollections List<GetEndpointsEndpointCollection>: The list of endpoint_collection.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
Filters List<GetEndpointsFilter>
Id string
State string: The current state of the endpoint.

CompartmentId string
EndpointCollections []GetEndpointsEndpointCollection: The list of endpoint_collection.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
Filters []GetEndpointsFilter
Id string
State string: The current state of the endpoint.

compartmentId String
endpointCollections List<GetEndpointsEndpointCollection>: The list of endpoint_collection.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
filters List<GetEndpointsFilter>
id String
state String: The current state of the endpoint.

compartmentId string
endpointCollections GetEndpointsEndpointCollection[]: The list of endpoint_collection.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable.
filters GetEndpointsFilter[]
id string
state string: The current state of the endpoint.

compartment_id str
endpoint_collections Sequence[generativeai.GetEndpointsEndpointCollection]: The list of endpoint_collection.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable.
filters Sequence[generativeai.GetEndpointsFilter]
id str
state str: The current state of the endpoint.

compartmentId String
endpointCollections List<Property Map>: The list of endpoint_collection.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
filters List<Property Map>
id String
state String: The current state of the endpoint.

Supporting Types

GetEndpointsEndpointCollection

Items List<GetEndpointsEndpointCollectionItem>

Items []GetEndpointsEndpointCollectionItem

items List<GetEndpointsEndpointCollectionItem>

items GetEndpointsEndpointCollectionItem[]

items Sequence[generativeai.GetEndpointsEndpointCollectionItem]

items List<Property Map>

GetEndpointsEndpointCollectionItem

CompartmentId string: The OCID of the compartment in which to list resources.
ContentModerationConfigs List<GetEndpointsEndpointCollectionItemContentModerationConfig>
DedicatedAiClusterId string
DefinedTags Dictionary<string, string>
Description string: An optional description of the endpoint.
DisplayName string: A filter to return only resources that match the given display name exactly.
FreeformTags Dictionary<string, string>
Id string: The OCID of the endpoint.
LifecycleDetails string
ModelId string: The OCID of the model that's used to create this endpoint.
State string: A filter to return only resources that their lifecycle state matches the given lifecycle state.
SystemTags Dictionary<string, string>
TimeCreated string
TimeUpdated string: The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

CompartmentId string: The OCID of the compartment in which to list resources.
ContentModerationConfigs []GetEndpointsEndpointCollectionItemContentModerationConfig
DedicatedAiClusterId string
DefinedTags map[string]string
Description string: An optional description of the endpoint.
DisplayName string: A filter to return only resources that match the given display name exactly.
FreeformTags map[string]string
Id string: The OCID of the endpoint.
LifecycleDetails string
ModelId string: The OCID of the model that's used to create this endpoint.
State string: A filter to return only resources that their lifecycle state matches the given lifecycle state.
SystemTags map[string]string
TimeCreated string
TimeUpdated string: The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

compartmentId String: The OCID of the compartment in which to list resources.
contentModerationConfigs List<GetEndpointsEndpointCollectionItemContentModerationConfig>
dedicatedAiClusterId String
definedTags Map<String,String>
description String: An optional description of the endpoint.
displayName String: A filter to return only resources that match the given display name exactly.
freeformTags Map<String,String>
id String: The OCID of the endpoint.
lifecycleDetails String
modelId String: The OCID of the model that's used to create this endpoint.
state String: A filter to return only resources that their lifecycle state matches the given lifecycle state.
systemTags Map<String,String>
timeCreated String
timeUpdated String: The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

compartmentId string: The OCID of the compartment in which to list resources.
contentModerationConfigs GetEndpointsEndpointCollectionItemContentModerationConfig[]
dedicatedAiClusterId string
definedTags {[key: string]: string}
description string: An optional description of the endpoint.
displayName string: A filter to return only resources that match the given display name exactly.
freeformTags {[key: string]: string}
id string: The OCID of the endpoint.
lifecycleDetails string
modelId string: The OCID of the model that's used to create this endpoint.
state string: A filter to return only resources that their lifecycle state matches the given lifecycle state.
systemTags {[key: string]: string}
timeCreated string
timeUpdated string: The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

compartment_id str: The OCID of the compartment in which to list resources.
content_moderation_configs Sequence[generativeai.GetEndpointsEndpointCollectionItemContentModerationConfig]
dedicated_ai_cluster_id str
defined_tags Mapping[str, str]
description str: An optional description of the endpoint.
display_name str: A filter to return only resources that match the given display name exactly.
freeform_tags Mapping[str, str]
id str: The OCID of the endpoint.
lifecycle_details str
model_id str: The OCID of the model that's used to create this endpoint.
state str: A filter to return only resources that their lifecycle state matches the given lifecycle state.
system_tags Mapping[str, str]
time_created str
time_updated str: The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

compartmentId String: The OCID of the compartment in which to list resources.
contentModerationConfigs List<Property Map>
dedicatedAiClusterId String
definedTags Map<String>
description String: An optional description of the endpoint.
displayName String: A filter to return only resources that match the given display name exactly.
freeformTags Map<String>
id String: The OCID of the endpoint.
lifecycleDetails String
modelId String: The OCID of the model that's used to create this endpoint.
state String: A filter to return only resources that their lifecycle state matches the given lifecycle state.
systemTags Map<String>
timeCreated String
timeUpdated String: The date and time that the endpoint was updated in the format of an RFC3339 datetime string.