1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getEndpoints
Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi

oci.GenerativeAi.getEndpoints

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi

    This data source provides the list of Endpoints in Oracle Cloud Infrastructure Generative Ai service.

    Lists the endpoints of a specific compartment.

    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/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
    The compartment OCID to create the endpoint in.
    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
    An OCID that uniquely identifies this endpoint resource.
    State string
    The current state of the endpoint.
    CompartmentId string
    The compartment OCID to create the endpoint in.
    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
    An OCID that uniquely identifies this endpoint resource.
    State string
    The current state of the endpoint.
    compartmentId String
    The compartment OCID to create the endpoint in.
    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
    An OCID that uniquely identifies this endpoint resource.
    state String
    The current state of the endpoint.
    compartmentId string
    The compartment OCID to create the endpoint in.
    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
    An OCID that uniquely identifies this endpoint resource.
    state string
    The current state of the endpoint.
    compartment_id str
    The compartment OCID to create the endpoint in.
    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
    An OCID that uniquely identifies this endpoint resource.
    state str
    The current state of the endpoint.
    compartmentId String
    The compartment OCID to create the endpoint in.
    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
    An OCID that uniquely identifies this endpoint resource.
    state String
    The current state of the endpoint.

    Supporting Types

    GetEndpointsEndpointCollection

    GetEndpointsEndpointCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    ContentModerationConfigs List<GetEndpointsEndpointCollectionItemContentModerationConfig>
    The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.
    DedicatedAiClusterId string
    The OCID of the dedicated AI cluster on which the model will be deployed to.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the endpoint.
    LifecycleDetails string
    A message describing the current state of the endpoint in more detail that can provide actionable information.
    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, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the endpoint was created in the format of an RFC3339 datetime 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
    The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.
    DedicatedAiClusterId string
    The OCID of the dedicated AI cluster on which the model will be deployed to.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the endpoint.
    LifecycleDetails string
    A message describing the current state of the endpoint in more detail that can provide actionable information.
    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]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the endpoint was created in the format of an RFC3339 datetime 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>
    The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.
    dedicatedAiClusterId String
    The OCID of the dedicated AI cluster on which the model will be deployed to.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the endpoint.
    lifecycleDetails String
    A message describing the current state of the endpoint in more detail that can provide actionable information.
    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,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the endpoint was created in the format of an RFC3339 datetime 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[]
    The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.
    dedicatedAiClusterId string
    The OCID of the dedicated AI cluster on which the model will be deployed to.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the endpoint.
    lifecycleDetails string
    A message describing the current state of the endpoint in more detail that can provide actionable information.
    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]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time that the endpoint was created in the format of an RFC3339 datetime 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]
    The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.
    dedicated_ai_cluster_id str
    The OCID of the dedicated AI cluster on which the model will be deployed to.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the endpoint.
    lifecycle_details str
    A message describing the current state of the endpoint in more detail that can provide actionable information.
    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, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time that the endpoint was created in the format of an RFC3339 datetime string.
    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>
    The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. It's recommended to use content moderation.
    dedicatedAiClusterId String
    The OCID of the dedicated AI cluster on which the model will be deployed to.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the endpoint.
    lifecycleDetails String
    A message describing the current state of the endpoint in more detail that can provide actionable information.
    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<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the endpoint was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time that the endpoint was updated in the format of an RFC3339 datetime string.

    GetEndpointsEndpointCollectionItemContentModerationConfig

    IsEnabled bool
    Whether to enable the content moderation feature.
    IsEnabled bool
    Whether to enable the content moderation feature.
    isEnabled Boolean
    Whether to enable the content moderation feature.
    isEnabled boolean
    Whether to enable the content moderation feature.
    is_enabled bool
    Whether to enable the content moderation feature.
    isEnabled Boolean
    Whether to enable the content moderation feature.

    GetEndpointsFilter

    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

    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 v1.36.0 published on Thursday, May 16, 2024 by Pulumi