1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AiLanguage
  5. getEndpoints
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.AiLanguage.getEndpoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 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!
Coming soon!
variables:
  testEndpoints:
    fn::invoke:
      function: oci:AiLanguage:getEndpoints
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${endpointDisplayName}
        endpointId: ${testEndpoint.id}
        modelId: ${testModel.id}
        projectId: ${testProject.id}
        state: ${endpointState}
Copy

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>
Copy
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]
Copy
func GetEndpoints(ctx *Context, args *GetEndpointsArgs, opts ...InvokeOption) (*GetEndpointsResult, error)
func GetEndpointsOutput(ctx *Context, args *GetEndpointsOutputArgs, opts ...InvokeOption) GetEndpointsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)
public static Output<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:AiLanguage/getEndpoints:getEndpoints
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. 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 Changes to this property will trigger replacement. []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 This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. 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 Changes to this property will trigger replacement. 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 This property is required. 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 Changes to this property will trigger replacement. 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

Items This property is required. []GetEndpointsEndpointCollectionItem
items This property is required. GetEndpointsEndpointCollectionItem[]
items This property is required. List<Property Map>

GetEndpointsEndpointCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
A short description of the endpoint.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. 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 This property is required. string
Unique identifier endpoint OCID of an endpoint that is immutable on creation.
InferenceUnits This property is required. int
Number of replicas required for this endpoint.
LifecycleDetails This property is required. 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 This property is required. string
The ID of the trained model for which to list the endpoints.
ProjectId This property is required. string
The ID of the project for which to list the objects.
State This property is required. string
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time the the endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated This property is required. string
The time the endpoint was updated. An RFC3339 formatted datetime string.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
A short description of the endpoint.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. 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 This property is required. string
Unique identifier endpoint OCID of an endpoint that is immutable on creation.
InferenceUnits This property is required. int
Number of replicas required for this endpoint.
LifecycleDetails This property is required. 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 This property is required. string
The ID of the trained model for which to list the endpoints.
ProjectId This property is required. string
The ID of the project for which to list the objects.
State This property is required. string
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time the the endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated This property is required. string
The time the endpoint was updated. An RFC3339 formatted datetime string.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
A short description of the endpoint.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. 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 This property is required. String
Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inferenceUnits This property is required. Integer
Number of replicas required for this endpoint.
lifecycleDetails This property is required. 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 This property is required. String
The ID of the trained model for which to list the endpoints.
projectId This property is required. String
The ID of the project for which to list the objects.
state This property is required. String
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time the the endpoint was created. An RFC3339 formatted datetime string.
timeUpdated This property is required. String
The time the endpoint was updated. An RFC3339 formatted datetime string.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
A short description of the endpoint.
displayName This property is required. string
A filter to return only resources that match the entire display name given.
freeformTags This property is required. {[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 This property is required. string
Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inferenceUnits This property is required. number
Number of replicas required for this endpoint.
lifecycleDetails This property is required. 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 This property is required. string
The ID of the trained model for which to list the endpoints.
projectId This property is required. string
The ID of the project for which to list the objects.
state This property is required. string
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
The time the the endpoint was created. An RFC3339 formatted datetime string.
timeUpdated This property is required. string
The time the endpoint was updated. An RFC3339 formatted datetime string.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
A short description of the endpoint.
display_name This property is required. str
A filter to return only resources that match the entire display name given.
freeform_tags This property is required. 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 This property is required. str
Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inference_units This property is required. int
Number of replicas required for this endpoint.
lifecycle_details This property is required. 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 This property is required. str
The ID of the trained model for which to list the endpoints.
project_id This property is required. str
The ID of the project for which to list the objects.
state This property is required. str
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
The time the the endpoint was created. An RFC3339 formatted datetime string.
time_updated This property is required. str
The time the endpoint was updated. An RFC3339 formatted datetime string.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
A short description of the endpoint.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. 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 This property is required. String
Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inferenceUnits This property is required. Number
Number of replicas required for this endpoint.
lifecycleDetails This property is required. 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 This property is required. String
The ID of the trained model for which to list the endpoints.
projectId This property is required. String
The ID of the project for which to list the objects.
state This property is required. String
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time the the endpoint was created. An RFC3339 formatted datetime string.
timeUpdated This property is required. String
The time the endpoint was updated. An RFC3339 formatted datetime string.

GetEndpointsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. 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.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi