1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AiLanguage
  5. getEndpoints
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.AiLanguage.getEndpoints

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

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

    Returns a list of Endpoints.

    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.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 = AiLanguageFunctions.getEndpoints(GetEndpointsArgs.builder()
                .compartmentId(compartmentId)
                .displayName(endpointDisplayName)
                .endpointId(testEndpoint.id())
                .modelId(testModel.id())
                .projectId(testProject.id())
                .state(endpointState)
                .build());
    
        }
    }
    
    variables:
      testEndpoints:
        fn::invoke:
          Function: oci:AiLanguage:getEndpoints
          Arguments:
            compartmentId: ${compartmentId}
            displayName: ${endpointDisplayName}
            endpointId: ${testEndpoint.id}
            modelId: ${testModel.id}
            projectId: ${testProject.id}
            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[_ailanguage.GetEndpointsFilter]] = None,
                      id: Optional[str] = None,
                      model_id: Optional[str] = None,
                      project_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[_ailanguage.GetEndpointsFilterArgs]]]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      model_id: Optional[pulumi.Input[str]] = None,
                      project_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:AiLanguage/getEndpoints:getEndpoints
      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<GetEndpointsFilter>
    Id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    ModelId string
    The ID of the trained model for which to list the endpoints.
    ProjectId string
    The ID of the project for which to list the objects.
    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 []GetEndpointsFilter
    Id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    ModelId string
    The ID of the trained model for which to list the endpoints.
    ProjectId string
    The ID of the project for which to list the objects.
    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<GetEndpointsFilter>
    id String
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    modelId String
    The ID of the trained model for which to list the endpoints.
    projectId String
    The ID of the project for which to list the objects.
    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 GetEndpointsFilter[]
    id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    modelId string
    The ID of the trained model for which to list the endpoints.
    projectId string
    The ID of the project for which to list the objects.
    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.GetEndpointsFilter]
    id str
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    model_id str
    The ID of the trained model for which to list the endpoints.
    project_id str
    The ID of the project for which to list the objects.
    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 endpoint OCID of an endpoint that is immutable on creation.
    modelId String
    The ID of the trained model for which to list the endpoints.
    projectId String
    The ID of the project for which to list the objects.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

    getEndpoints Result

    The following output properties are available:

    CompartmentId string
    The OCID for the endpoint compartment.
    EndpointCollections List<GetEndpointsEndpointCollection>
    The list of endpoint_collection.
    DisplayName string
    A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    Filters List<GetEndpointsFilter>
    Id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    ModelId string
    The OCID of the model to associate with the endpoint.
    ProjectId string
    The OCID of the project to associate with the Endpoint.
    State string
    The state of the endpoint.
    CompartmentId string
    The OCID for the endpoint compartment.
    EndpointCollections []GetEndpointsEndpointCollection
    The list of endpoint_collection.
    DisplayName string
    A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    Filters []GetEndpointsFilter
    Id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    ModelId string
    The OCID of the model to associate with the endpoint.
    ProjectId string
    The OCID of the project to associate with the Endpoint.
    State string
    The state of the endpoint.
    compartmentId String
    The OCID for the endpoint compartment.
    endpointCollections List<GetEndpointsEndpointCollection>
    The list of endpoint_collection.
    displayName String
    A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    filters List<GetEndpointsFilter>
    id String
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    modelId String
    The OCID of the model to associate with the endpoint.
    projectId String
    The OCID of the project to associate with the Endpoint.
    state String
    The state of the endpoint.
    compartmentId string
    The OCID for the endpoint compartment.
    endpointCollections GetEndpointsEndpointCollection[]
    The list of endpoint_collection.
    displayName string
    A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    filters GetEndpointsFilter[]
    id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    modelId string
    The OCID of the model to associate with the endpoint.
    projectId string
    The OCID of the project to associate with the Endpoint.
    state string
    The state of the endpoint.
    compartment_id str
    The OCID for the endpoint compartment.
    endpoint_collections Sequence[ailanguage.GetEndpointsEndpointCollection]
    The list of endpoint_collection.
    display_name str
    A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    filters Sequence[ailanguage.GetEndpointsFilter]
    id str
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    model_id str
    The OCID of the model to associate with the endpoint.
    project_id str
    The OCID of the project to associate with the Endpoint.
    state str
    The state of the endpoint.
    compartmentId String
    The OCID for the endpoint compartment.
    endpointCollections List<Property Map>
    The list of endpoint_collection.
    displayName String
    A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    filters List<Property Map>
    id String
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    modelId String
    The OCID of the model to associate with the endpoint.
    projectId String
    The OCID of the project to associate with the Endpoint.
    state String
    The state of the endpoint.

    Supporting Types

    GetEndpointsEndpointCollection

    GetEndpointsEndpointCollectionItem

    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags Dictionary<string, object>
    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 the endpoint.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    FreeformTags Dictionary<string, object>
    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 endpoint OCID of an endpoint that is immutable on creation.
    InferenceUnits int
    Number of replicas required for this endpoint.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    ModelId string
    The ID of the trained model for which to list the endpoints.
    ProjectId string
    The ID of the project for which to list the objects.
    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 time the the endpoint was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the endpoint was updated. An RFC3339 formatted datetime string.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags map[string]interface{}
    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 the endpoint.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    FreeformTags map[string]interface{}
    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 endpoint OCID of an endpoint that is immutable on creation.
    InferenceUnits int
    Number of replicas required for this endpoint.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    ModelId string
    The ID of the trained model for which to list the endpoints.
    ProjectId string
    The ID of the project for which to list the objects.
    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 time the the endpoint was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the endpoint was updated. An RFC3339 formatted datetime string.
    compartmentId String
    The ID of the compartment in which to list resources.
    definedTags Map<String,Object>
    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 the endpoint.
    displayName String
    A filter to return only resources that match the entire display name given.
    freeformTags Map<String,Object>
    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 endpoint OCID of an endpoint that is immutable on creation.
    inferenceUnits Integer
    Number of replicas required for this endpoint.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    modelId String
    The ID of the trained model for which to list the endpoints.
    projectId String
    The ID of the project for which to list the objects.
    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 time the the endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the endpoint was updated. An RFC3339 formatted datetime string.
    compartmentId string
    The ID of the compartment in which to list resources.
    definedTags {[key: string]: any}
    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 the endpoint.
    displayName string
    A filter to return only resources that match the entire display name given.
    freeformTags {[key: string]: any}
    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 endpoint OCID of an endpoint that is immutable on creation.
    inferenceUnits number
    Number of replicas required for this endpoint.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    modelId string
    The ID of the trained model for which to list the endpoints.
    projectId string
    The ID of the project for which to list the objects.
    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 time the the endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the endpoint was updated. An RFC3339 formatted datetime string.
    compartment_id str
    The ID of the compartment in which to list resources.
    defined_tags Mapping[str, Any]
    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 the endpoint.
    display_name str
    A filter to return only resources that match the entire display name given.
    freeform_tags Mapping[str, Any]
    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 endpoint OCID of an endpoint that is immutable on creation.
    inference_units int
    Number of replicas required for this endpoint.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    model_id str
    The ID of the trained model for which to list the endpoints.
    project_id str
    The ID of the project for which to list the objects.
    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 time the the endpoint was created. An RFC3339 formatted datetime string.
    time_updated str
    The time the endpoint was updated. An RFC3339 formatted datetime string.
    compartmentId String
    The ID of the compartment in which to list resources.
    definedTags Map<Any>
    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 the endpoint.
    displayName String
    A filter to return only resources that match the entire display name given.
    freeformTags Map<Any>
    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 endpoint OCID of an endpoint that is immutable on creation.
    inferenceUnits Number
    Number of replicas required for this endpoint.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    modelId String
    The ID of the trained model for which to list the endpoints.
    projectId String
    The ID of the project for which to list the objects.
    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 time the the endpoint was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the endpoint was updated. An RFC3339 formatted datetime string.

    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.41.0 published on Wednesday, Jun 19, 2024 by Pulumi