Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getContext

Retrieves the specified context.

Using getContext

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 getContext(args: GetContextArgs, opts?: InvokeOptions): Promise<GetContextResult>
function getContextOutput(args: GetContextOutputArgs, opts?: InvokeOptions): Output<GetContextResult>
def get_context(context_id: Optional[str] = None,
                environment_id: Optional[str] = None,
                location: Optional[str] = None,
                project: Optional[str] = None,
                session_id: Optional[str] = None,
                user_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetContextResult
def get_context_output(context_id: Optional[pulumi.Input[str]] = None,
                environment_id: Optional[pulumi.Input[str]] = None,
                location: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                session_id: Optional[pulumi.Input[str]] = None,
                user_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetContextResult]
func LookupContext(ctx *Context, args *LookupContextArgs, opts ...InvokeOption) (*LookupContextResult, error)
func LookupContextOutput(ctx *Context, args *LookupContextOutputArgs, opts ...InvokeOption) LookupContextResultOutput

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

public static class GetContext 
{
    public static Task<GetContextResult> InvokeAsync(GetContextArgs args, InvokeOptions? opts = null)
    public static Output<GetContextResult> Invoke(GetContextInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetContextResult> getContext(GetContextArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:dialogflow/v2beta1:getContext
  arguments:
    # arguments dictionary

The following arguments are supported:

ContextId string
EnvironmentId string
Location string
SessionId string
UserId string
Project string
ContextId string
EnvironmentId string
Location string
SessionId string
UserId string
Project string
contextId String
environmentId String
location String
sessionId String
userId String
project String
contextId string
environmentId string
location string
sessionId string
userId string
project string
contextId String
environmentId String
location String
sessionId String
userId String
project String

getContext Result

The following output properties are available:

LifespanCount int

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

Name string

The unique identifier of the context. Supported formats: - projects//agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects//locations//agent/environments//users//sessions//contexts/, The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size

Parameters Dictionary<string, string>

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

LifespanCount int

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

Name string

The unique identifier of the context. Supported formats: - projects//agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects//locations//agent/environments//users//sessions//contexts/, The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size

Parameters map[string]string

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

lifespanCount Integer

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

name String

The unique identifier of the context. Supported formats: - projects//agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects//locations//agent/environments//users//sessions//contexts/, The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size

parameters Map<String,String>

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

lifespanCount number

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

name string

The unique identifier of the context. Supported formats: - projects//agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects//locations//agent/environments//users//sessions//contexts/, The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size

parameters {[key: string]: string}

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

lifespan_count int

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

name str

The unique identifier of the context. Supported formats: - projects//agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects//locations//agent/environments//users//sessions//contexts/, The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size

parameters Mapping[str, str]

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

lifespanCount Number

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

name String

The unique identifier of the context. Supported formats: - projects//agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects//locations//agent/environments//users//sessions//contexts/, The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size

parameters Map<String>

Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0