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

oci.AiLanguage.getEndpoint

Explore with Pulumi AI

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

    This data source provides details about a specific Endpoint resource in Oracle Cloud Infrastructure Ai Language service.

    Gets an endpoint by identifier

    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.GetEndpointArgs;
    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 testEndpoint = AiLanguageFunctions.getEndpoint(GetEndpointArgs.builder()
                .endpointId(testEndpointOciAiLanguageEndpoint.id())
                .build());
    
        }
    }
    
    variables:
      testEndpoint:
        fn::invoke:
          Function: oci:AiLanguage:getEndpoint
          Arguments:
            endpointId: ${testEndpointOciAiLanguageEndpoint.id}
    

    Using getEndpoint

    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 getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
    function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>
    def get_endpoint(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEndpointResult
    def get_endpoint_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]
    func GetEndpoint(ctx *Context, args *GetEndpointArgs, opts ...InvokeOption) (*GetEndpointResult, error)
    func GetEndpointOutput(ctx *Context, args *GetEndpointOutputArgs, opts ...InvokeOption) GetEndpointResultOutput

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

    public static class GetEndpoint 
    {
        public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
        public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:AiLanguage/getEndpoint:getEndpoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    Id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    id String
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    id string
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    id str
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.
    id String
    Unique identifier endpoint OCID of an endpoint that is immutable on creation.

    getEndpoint Result

    The following output properties are available:

    CompartmentId string
    The OCID for the endpoint compartment.
    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 user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    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 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.
    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 OCID for the endpoint compartment.
    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 user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    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 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.
    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 OCID for the endpoint compartment.
    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 user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    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 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.
    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 OCID for the endpoint compartment.
    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 user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    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 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.
    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 OCID for the endpoint compartment.
    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 user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    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 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.
    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 OCID for the endpoint compartment.
    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 user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
    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 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.
    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.

    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