`dataGoogleVertexAiReasoningEngineQuery` Submodule

Constructs

DataGoogleVertexAiReasoningEngineQuery

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query google_vertex_ai_reasoning_engine_query}.

Initializers

using Io.Cdktn.Providers.Google;

new DataGoogleVertexAiReasoningEngineQuery(Construct Scope, string Id, DataGoogleVertexAiReasoningEngineQueryConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`DataGoogleVertexAiReasoningEngineQueryConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: DataGoogleVertexAiReasoningEngineQueryConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`With`	Applies one or more mixins to this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	Adds this resource to the terraform JSON output.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`ResetClassMethod`	No description.
`ResetId`	No description.
`ResetInput`	No description.
`ResetProject`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`With`

private IConstruct With(params IMixin[] Mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`Mixins`^Required

Type: params Constructs.IMixin[]

The mixins to apply.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`ResetClassMethod`

private void ResetClassMethod()

`ResetId`

private void ResetId()

`ResetInput`

private void ResetInput()

`ResetProject`

private void ResetProject()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformDataSource`	No description.
`GenerateConfigForImport`	Generates CDKTN code for importing a DataGoogleVertexAiReasoningEngineQuery resource upon running "cdktn plan ".

`IsConstruct`

using Io.Cdktn.Providers.Google;

DataGoogleVertexAiReasoningEngineQuery.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using Io.Cdktn.Providers.Google;

DataGoogleVertexAiReasoningEngineQuery.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformDataSource`

using Io.Cdktn.Providers.Google;

DataGoogleVertexAiReasoningEngineQuery.IsTerraformDataSource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using Io.Cdktn.Providers.Google;

DataGoogleVertexAiReasoningEngineQuery.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTN code for importing a DataGoogleVertexAiReasoningEngineQuery resource upon running "cdktn plan ".

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

The construct id used in the generated config for the DataGoogleVertexAiReasoningEngineQuery to import.

`ImportFromId`^Required

Type: string

The id of the existing DataGoogleVertexAiReasoningEngineQuery that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

? Optional instance of the provider where the DataGoogleVertexAiReasoningEngineQuery to import is found.

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`Io.Cdktn.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`Io.Cdktn.TerraformProviderGeneratorMetadata`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Output`	`string`	No description.
`ClassMethodInput`	`string`	No description.
`IdInput`	`string`	No description.
`InputInput`	`string`	No description.
`ProjectInput`	`string`	No description.
`ReasoningEngineIdInput`	`string`	No description.
`RegionInput`	`string`	No description.
`ClassMethod`	`string`	No description.
`Id`	`string`	No description.
`Input`	`string`	No description.
`Project`	`string`	No description.
`ReasoningEngineId`	`string`	No description.
`Region`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: Io.Cdktn.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: Io.Cdktn.TerraformProviderGeneratorMetadata

`Count`^Optional

public double|TerraformCount Count { get; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: Io.Cdktn.TerraformProvider

`Output`^Required

public string Output { get; }

Type: string

`ClassMethodInput`^Optional

public string ClassMethodInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`InputInput`^Optional

public string InputInput { get; }

Type: string

`ProjectInput`^Optional

public string ProjectInput { get; }

Type: string

`ReasoningEngineIdInput`^Optional

public string ReasoningEngineIdInput { get; }

Type: string

`RegionInput`^Optional

public string RegionInput { get; }

Type: string

`ClassMethod`^Required

public string ClassMethod { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`Input`^Required

public string Input { get; }

Type: string

`Project`^Required

public string Project { get; }

Type: string

`ReasoningEngineId`^Required

public string ReasoningEngineId { get; }

Type: string

`Region`^Required

public string Region { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

DataGoogleVertexAiReasoningEngineQueryConfig

Initializer

using Io.Cdktn.Providers.Google;

new DataGoogleVertexAiReasoningEngineQueryConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string ReasoningEngineId,
    string Region,
    string ClassMethod = null,
    string Id = null,
    string Input = null,
    string Project = null
};

Properties

Name	Type	Description
`Connection`	`Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`Io.Cdktn.ITerraformDependable[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Provisioners`	`Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.RemoteExecProvisioner[]`	No description.
`ReasoningEngineId`	`string`	The id of the Vertex Agent Engine to query.
`Region`	`string`	The location of the resource.
`ClassMethod`	`string`	Class method to be used for the query. It is optional and defaults to "query" if unspecified.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#id DataGoogleVertexAiReasoningEngineQuery#id}.
`Input`	`string`	Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc..
`Project`	`string`	The project of the resource. If not provided, the provider default project is used.

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; set; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: Io.Cdktn.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`ReasoningEngineId`^Required

public string ReasoningEngineId { get; set; }

Type: string

The id of the Vertex Agent Engine to query.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#reasoning_engine_id DataGoogleVertexAiReasoningEngineQuery#reasoning_engine_id}

`Region`^Required

public string Region { get; set; }

Type: string

The location of the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#region DataGoogleVertexAiReasoningEngineQuery#region}

`ClassMethod`^Optional

public string ClassMethod { get; set; }

Type: string

Class method to be used for the query. It is optional and defaults to "query" if unspecified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#class_method DataGoogleVertexAiReasoningEngineQuery#class_method}

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#id DataGoogleVertexAiReasoningEngineQuery#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`Input`^Optional

public string Input { get; set; }

Type: string

Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#input DataGoogleVertexAiReasoningEngineQuery#input}

`Project`^Optional

public string Project { get; set; }

Type: string

The project of the resource. If not provided, the provider default project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/data-sources/vertex_ai_reasoning_engine_query#project DataGoogleVertexAiReasoningEngineQuery#project}

FilesExpand file tree

dataGoogleVertexAiReasoningEngineQuery.csharp.md

Latest commit

History

dataGoogleVertexAiReasoningEngineQuery.csharp.md

File metadata and controls

dataGoogleVertexAiReasoningEngineQuery Submodule

Constructs