Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getHostQuery

Get status of a query submitted at host level. If the query is still in progress, the state is set to “running” After the query has completed successfully, state is set to “completed”

Using getHostQuery

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 getHostQuery(args: GetHostQueryArgs, opts?: InvokeOptions): Promise<GetHostQueryResult>
function getHostQueryOutput(args: GetHostQueryOutputArgs, opts?: InvokeOptions): Output<GetHostQueryResult>
def get_host_query(host_query_id: Optional[str] = None,
                   organization_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetHostQueryResult
def get_host_query_output(host_query_id: Optional[pulumi.Input[str]] = None,
                   organization_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetHostQueryResult]
func LookupHostQuery(ctx *Context, args *LookupHostQueryArgs, opts ...InvokeOption) (*LookupHostQueryResult, error)
func LookupHostQueryOutput(ctx *Context, args *LookupHostQueryOutputArgs, opts ...InvokeOption) LookupHostQueryResultOutput

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

public static class GetHostQuery 
{
    public static Task<GetHostQueryResult> InvokeAsync(GetHostQueryArgs args, InvokeOptions? opts = null)
    public static Output<GetHostQueryResult> Invoke(GetHostQueryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetHostQueryResult> getHostQuery(GetHostQueryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:apigee/v1:getHostQuery
  Arguments:
    # Arguments dictionary

The following arguments are supported:

getHostQuery Result

The following output properties are available:

Created string

Creation time of the query.

EnvgroupHostname string

Hostname is available only when query is executed at host level.

Error string

Error is set when query fails.

ExecutionTime string

ExecutionTime is available only after the query is completed.

Name string

Asynchronous Query Name.

QueryParams Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1QueryMetadataResponse

Contains information like metrics, dimenstions etc of the AsyncQuery.

ReportDefinitionId string

Asynchronous Report ID.

Result Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1AsyncQueryResultResponse

Result is available only after the query is completed.

ResultFileSize string

ResultFileSize is available only after the query is completed.

ResultRows string

ResultRows is available only after the query is completed.

Self string

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

State string

Query state could be "enqueued", "running", "completed", "failed".

Updated string

Last updated timestamp for the query.

Created string

Creation time of the query.

EnvgroupHostname string

Hostname is available only when query is executed at host level.

Error string

Error is set when query fails.

ExecutionTime string

ExecutionTime is available only after the query is completed.

Name string

Asynchronous Query Name.

QueryParams GoogleCloudApigeeV1QueryMetadataResponse

Contains information like metrics, dimenstions etc of the AsyncQuery.

ReportDefinitionId string

Asynchronous Report ID.

Result GoogleCloudApigeeV1AsyncQueryResultResponse

Result is available only after the query is completed.

ResultFileSize string

ResultFileSize is available only after the query is completed.

ResultRows string

ResultRows is available only after the query is completed.

Self string

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

State string

Query state could be "enqueued", "running", "completed", "failed".

Updated string

Last updated timestamp for the query.

created String

Creation time of the query.

envgroupHostname String

Hostname is available only when query is executed at host level.

error String

Error is set when query fails.

executionTime String

ExecutionTime is available only after the query is completed.

name String

Asynchronous Query Name.

queryParams GoogleCloudApigeeV1QueryMetadataResponse

Contains information like metrics, dimenstions etc of the AsyncQuery.

reportDefinitionId String

Asynchronous Report ID.

result GoogleCloudApigeeV1AsyncQueryResultResponse

Result is available only after the query is completed.

resultFileSize String

ResultFileSize is available only after the query is completed.

resultRows String

ResultRows is available only after the query is completed.

self String

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

state String

Query state could be "enqueued", "running", "completed", "failed".

updated String

Last updated timestamp for the query.

created string

Creation time of the query.

envgroupHostname string

Hostname is available only when query is executed at host level.

error string

Error is set when query fails.

executionTime string

ExecutionTime is available only after the query is completed.

name string

Asynchronous Query Name.

queryParams GoogleCloudApigeeV1QueryMetadataResponse

Contains information like metrics, dimenstions etc of the AsyncQuery.

reportDefinitionId string

Asynchronous Report ID.

result GoogleCloudApigeeV1AsyncQueryResultResponse

Result is available only after the query is completed.

resultFileSize string

ResultFileSize is available only after the query is completed.

resultRows string

ResultRows is available only after the query is completed.

self string

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

state string

Query state could be "enqueued", "running", "completed", "failed".

updated string

Last updated timestamp for the query.

created str

Creation time of the query.

envgroup_hostname str

Hostname is available only when query is executed at host level.

error str

Error is set when query fails.

execution_time str

ExecutionTime is available only after the query is completed.

name str

Asynchronous Query Name.

query_params GoogleCloudApigeeV1QueryMetadataResponse

Contains information like metrics, dimenstions etc of the AsyncQuery.

report_definition_id str

Asynchronous Report ID.

result GoogleCloudApigeeV1AsyncQueryResultResponse

Result is available only after the query is completed.

result_file_size str

ResultFileSize is available only after the query is completed.

result_rows str

ResultRows is available only after the query is completed.

self str

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

state str

Query state could be "enqueued", "running", "completed", "failed".

updated str

Last updated timestamp for the query.

created String

Creation time of the query.

envgroupHostname String

Hostname is available only when query is executed at host level.

error String

Error is set when query fails.

executionTime String

ExecutionTime is available only after the query is completed.

name String

Asynchronous Query Name.

queryParams Property Map

Contains information like metrics, dimenstions etc of the AsyncQuery.

reportDefinitionId String

Asynchronous Report ID.

result Property Map

Result is available only after the query is completed.

resultFileSize String

ResultFileSize is available only after the query is completed.

resultRows String

ResultRows is available only after the query is completed.

self String

Self link of the query. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd

state String

Query state could be "enqueued", "running", "completed", "failed".

updated String

Last updated timestamp for the query.

Supporting Types

GoogleCloudApigeeV1AsyncQueryResultResponse

Expires string

Query result will be unaccessable after this time.

Self string

Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

Expires string

Query result will be unaccessable after this time.

Self string

Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

expires String

Query result will be unaccessable after this time.

self String

Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

expires string

Query result will be unaccessable after this time.

self string

Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

expires str

Query result will be unaccessable after this time.

self str

Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

expires String

Query result will be unaccessable after this time.

self String

Self link of the query results. Example: /organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

GoogleCloudApigeeV1QueryMetadataResponse

Dimensions List<string>

Dimensions of the AsyncQuery.

EndTimestamp string

End timestamp of the query range.

Metrics List<string>

Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]

OutputFormat string

Output format.

StartTimestamp string

Start timestamp of the query range.

TimeUnit string

Query GroupBy time unit.

Dimensions []string

Dimensions of the AsyncQuery.

EndTimestamp string

End timestamp of the query range.

Metrics []string

Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]

OutputFormat string

Output format.

StartTimestamp string

Start timestamp of the query range.

TimeUnit string

Query GroupBy time unit.

dimensions List<String>

Dimensions of the AsyncQuery.

endTimestamp String

End timestamp of the query range.

metrics List<String>

Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]

outputFormat String

Output format.

startTimestamp String

Start timestamp of the query range.

timeUnit String

Query GroupBy time unit.

dimensions string[]

Dimensions of the AsyncQuery.

endTimestamp string

End timestamp of the query range.

metrics string[]

Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]

outputFormat string

Output format.

startTimestamp string

Start timestamp of the query range.

timeUnit string

Query GroupBy time unit.

dimensions Sequence[str]

Dimensions of the AsyncQuery.

end_timestamp str

End timestamp of the query range.

metrics Sequence[str]

Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]

output_format str

Output format.

start_timestamp str

Start timestamp of the query range.

time_unit str

Query GroupBy time unit.

dimensions List<String>

Dimensions of the AsyncQuery.

endTimestamp String

End timestamp of the query range.

metrics List<String>

Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]

outputFormat String

Output format.

startTimestamp String

Start timestamp of the query range.

timeUnit String

Query GroupBy time unit.

Package Details

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