Oracle Cloud Infrastructure
getOdaInstances
This data source provides the list of Oda Instances in Oracle Cloud Infrastructure Digital Assistant service.
Returns a page of Digital Assistant instances that belong to the specified compartment.
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header’s value as the page
query parameter.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testOdaInstances = Output.Create(Oci.Oda.GetOdaInstances.InvokeAsync(new Oci.Oda.GetOdaInstancesArgs
{
CompartmentId = @var.Compartment_id,
DisplayName = @var.Oda_instance_display_name,
State = @var.Oda_instance_state,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Oda"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Oda.GetOdaInstances(ctx, &oda.GetOdaInstancesArgs{
CompartmentId: _var.Compartment_id,
DisplayName: pulumi.StringRef(_var.Oda_instance_display_name),
State: pulumi.StringRef(_var.Oda_instance_state),
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_oda_instances = oci.Oda.get_oda_instances(compartment_id=var["compartment_id"],
display_name=var["oda_instance_display_name"],
state=var["oda_instance_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testOdaInstances = oci.Oda.getOdaInstances({
compartmentId: _var.compartment_id,
displayName: _var.oda_instance_display_name,
state: _var.oda_instance_state,
});
Coming soon!
Using getOdaInstances
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 getOdaInstances(args: GetOdaInstancesArgs, opts?: InvokeOptions): Promise<GetOdaInstancesResult>
function getOdaInstancesOutput(args: GetOdaInstancesOutputArgs, opts?: InvokeOptions): Output<GetOdaInstancesResult>
def get_oda_instances(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_oda.GetOdaInstancesFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetOdaInstancesResult
def get_oda_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_oda.GetOdaInstancesFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetOdaInstancesResult]
func GetOdaInstances(ctx *Context, args *GetOdaInstancesArgs, opts ...InvokeOption) (*GetOdaInstancesResult, error)
func GetOdaInstancesOutput(ctx *Context, args *GetOdaInstancesOutputArgs, opts ...InvokeOption) GetOdaInstancesResultOutput
> Note: This function is named GetOdaInstances
in the Go SDK.
public static class GetOdaInstances
{
public static Task<GetOdaInstancesResult> InvokeAsync(GetOdaInstancesArgs args, InvokeOptions? opts = null)
public static Output<GetOdaInstancesResult> Invoke(GetOdaInstancesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOdaInstancesResult> getOdaInstances(GetOdaInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:Oda/getOdaInstances:getOdaInstances
Arguments:
# Arguments dictionary
The following arguments are supported:
- Compartment
Id string List the Digital Assistant instances that belong to this compartment.
- Display
Name string List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- Filters
List<Get
Oda Instances Filter> - State string
List only the Digital Assistant instances that are in this lifecycle state.
- Compartment
Id string List the Digital Assistant instances that belong to this compartment.
- Display
Name string List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- Filters
[]Get
Oda Instances Filter - State string
List only the Digital Assistant instances that are in this lifecycle state.
- compartment
Id String List the Digital Assistant instances that belong to this compartment.
- display
Name String List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- filters
List<Get
Instances Filter> - state String
List only the Digital Assistant instances that are in this lifecycle state.
- compartment
Id string List the Digital Assistant instances that belong to this compartment.
- display
Name string List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- filters
Get
Oda Instances Filter[] - state string
List only the Digital Assistant instances that are in this lifecycle state.
- compartment_
id str List the Digital Assistant instances that belong to this compartment.
- display_
name str List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- filters
Get
Oda Instances Filter] - state str
List only the Digital Assistant instances that are in this lifecycle state.
- compartment
Id String List the Digital Assistant instances that belong to this compartment.
- display
Name String List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- filters List<Property Map>
- state String
List only the Digital Assistant instances that are in this lifecycle state.
getOdaInstances Result
The following output properties are available:
- Compartment
Id string Identifier of the compartment that the instance belongs to.
- Id string
The provider-assigned unique ID for this managed resource.
- Oda
Instances List<GetOda Instances Oda Instance> The list of oda_instances.
- Display
Name string User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- Filters
List<Get
Oda Instances Filter> - State string
The current state of the Digital Assistant instance.
- Compartment
Id string Identifier of the compartment that the instance belongs to.
- Id string
The provider-assigned unique ID for this managed resource.
- Oda
Instances []GetOda Instances Oda Instance The list of oda_instances.
- Display
Name string User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- Filters
[]Get
Oda Instances Filter - State string
The current state of the Digital Assistant instance.
- compartment
Id String Identifier of the compartment that the instance belongs to.
- id String
The provider-assigned unique ID for this managed resource.
- oda
Instances List<GetInstances Instance> The list of oda_instances.
- display
Name String User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- filters
List<Get
Instances Filter> - state String
The current state of the Digital Assistant instance.
- compartment
Id string Identifier of the compartment that the instance belongs to.
- id string
The provider-assigned unique ID for this managed resource.
- oda
Instances GetOda Instances Oda Instance[] The list of oda_instances.
- display
Name string User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- filters
Get
Oda Instances Filter[] - state string
The current state of the Digital Assistant instance.
- compartment_
id str Identifier of the compartment that the instance belongs to.
- id str
The provider-assigned unique ID for this managed resource.
- oda_
instances GetOda Instances Oda Instance] The list of oda_instances.
- display_
name str User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- filters
Get
Oda Instances Filter] - state str
The current state of the Digital Assistant instance.
- compartment
Id String Identifier of the compartment that the instance belongs to.
- id String
The provider-assigned unique ID for this managed resource.
- oda
Instances List<Property Map> The list of oda_instances.
- display
Name String User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.
- filters List<Property Map>
- state String
The current state of the Digital Assistant instance.
Supporting Types
GetOdaInstancesFilter
GetOdaInstancesOdaInstance
- Compartment
Id string List the Digital Assistant instances that belong to this compartment.
- Connector
Url string URL for the connector's endpoint.
- Dictionary<string, object>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- Description string
Description of the Digital Assistant instance.
- Display
Name string List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- 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 immutable identifier that was assigned when the instance was created.
- Lifecycle
Sub stringState The current sub-state of the Digital Assistant instance.
- Shape
Name string Shape or size of the instance.
- State string
List only the Digital Assistant instances that are in this lifecycle state.
- State
Message string A message that describes the current state in more detail. For example, actionable information about an instance that's in the
FAILED
state.- Time
Created string When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- Time
Updated string When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- Web
App stringUrl URL for the Digital Assistant web application that's associated with the instance.
- Compartment
Id string List the Digital Assistant instances that belong to this compartment.
- Connector
Url string URL for the connector's endpoint.
- map[string]interface{}
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- Description string
Description of the Digital Assistant instance.
- Display
Name string List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- 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 immutable identifier that was assigned when the instance was created.
- Lifecycle
Sub stringState The current sub-state of the Digital Assistant instance.
- Shape
Name string Shape or size of the instance.
- State string
List only the Digital Assistant instances that are in this lifecycle state.
- State
Message string A message that describes the current state in more detail. For example, actionable information about an instance that's in the
FAILED
state.- Time
Created string When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- Time
Updated string When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- Web
App stringUrl URL for the Digital Assistant web application that's associated with the instance.
- compartment
Id String List the Digital Assistant instances that belong to this compartment.
- connector
Url String URL for the connector's endpoint.
- Map<String,Object>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- description String
Description of the Digital Assistant instance.
- display
Name String List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- 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 immutable identifier that was assigned when the instance was created.
- lifecycle
Sub StringState The current sub-state of the Digital Assistant instance.
- shape
Name String Shape or size of the instance.
- state String
List only the Digital Assistant instances that are in this lifecycle state.
- state
Message String A message that describes the current state in more detail. For example, actionable information about an instance that's in the
FAILED
state.- time
Created String When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time
Updated String When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web
App StringUrl URL for the Digital Assistant web application that's associated with the instance.
- compartment
Id string List the Digital Assistant instances that belong to this compartment.
- connector
Url string URL for the connector's endpoint.
- {[key: string]: any}
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- description string
Description of the Digital Assistant instance.
- display
Name string List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- {[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 immutable identifier that was assigned when the instance was created.
- lifecycle
Sub stringState The current sub-state of the Digital Assistant instance.
- shape
Name string Shape or size of the instance.
- state string
List only the Digital Assistant instances that are in this lifecycle state.
- state
Message string A message that describes the current state in more detail. For example, actionable information about an instance that's in the
FAILED
state.- time
Created string When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time
Updated string When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web
App stringUrl URL for the Digital Assistant web application that's associated with the instance.
- compartment_
id str List the Digital Assistant instances that belong to this compartment.
- connector_
url str URL for the connector's endpoint.
- Mapping[str, Any]
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- description str
Description of the Digital Assistant instance.
- display_
name str List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- 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 immutable identifier that was assigned when the instance was created.
- lifecycle_
sub_ strstate The current sub-state of the Digital Assistant instance.
- shape_
name str Shape or size of the instance.
- state str
List only the Digital Assistant instances that are in this lifecycle state.
- state_
message str A message that describes the current state in more detail. For example, actionable information about an instance that's in the
FAILED
state.- time_
created str When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time_
updated str When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web_
app_ strurl URL for the Digital Assistant web application that's associated with the instance.
- compartment
Id String List the Digital Assistant instances that belong to this compartment.
- connector
Url String URL for the connector's endpoint.
- Map<Any>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- description String
Description of the Digital Assistant instance.
- display
Name String List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example:
My new resource
- 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 immutable identifier that was assigned when the instance was created.
- lifecycle
Sub StringState The current sub-state of the Digital Assistant instance.
- shape
Name String Shape or size of the instance.
- state String
List only the Digital Assistant instances that are in this lifecycle state.
- state
Message String A message that describes the current state in more detail. For example, actionable information about an instance that's in the
FAILED
state.- time
Created String When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.
- time
Updated String When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.
- web
App StringUrl URL for the Digital Assistant web application that's associated with the instance.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.