Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigee/v1.getQuery
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Get query status 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 getQuery
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 getQuery(args: GetQueryArgs, opts?: InvokeOptions): Promise<GetQueryResult>
function getQueryOutput(args: GetQueryOutputArgs, opts?: InvokeOptions): Output<GetQueryResult>
def get_query(environment_id: Optional[str] = None,
organization_id: Optional[str] = None,
query_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetQueryResult
def get_query_output(environment_id: Optional[pulumi.Input[str]] = None,
organization_id: Optional[pulumi.Input[str]] = None,
query_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetQueryResult]
func LookupQuery(ctx *Context, args *LookupQueryArgs, opts ...InvokeOption) (*LookupQueryResult, error)
func LookupQueryOutput(ctx *Context, args *LookupQueryOutputArgs, opts ...InvokeOption) LookupQueryResultOutput
> Note: This function is named LookupQuery
in the Go SDK.
public static class GetQuery
{
public static Task<GetQueryResult> InvokeAsync(GetQueryArgs args, InvokeOptions? opts = null)
public static Output<GetQueryResult> Invoke(GetQueryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetQueryResult> getQuery(GetQueryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:apigee/v1:getQuery
arguments:
# arguments dictionary
The following arguments are supported:
- Environment
Id This property is required. string - Organization
Id This property is required. string - Query
Id This property is required. string
- Environment
Id This property is required. string - Organization
Id This property is required. string - Query
Id This property is required. string
- environment
Id This property is required. String - organization
Id This property is required. String - query
Id This property is required. String
- environment
Id This property is required. string - organization
Id This property is required. string - query
Id This property is required. string
- environment_
id This property is required. str - organization_
id This property is required. str - query_
id This property is required. str
- environment
Id This property is required. String - organization
Id This property is required. String - query
Id This property is required. String
getQuery Result
The following output properties are available:
- Created string
- Creation time of the query.
- Envgroup
Hostname string - Hostname is available only when query is executed at host level.
- Error string
- Error is set when query fails.
- Execution
Time string - ExecutionTime is available only after the query is completed.
- Name string
- Asynchronous Query Name.
- Query
Params Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Query Metadata Response - Contains information like metrics, dimenstions etc of the AsyncQuery.
- Report
Definition stringId - Asynchronous Report ID.
- Result
Pulumi.
Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Async Query Result Response - Result is available only after the query is completed.
- Result
File stringSize - ResultFileSize is available only after the query is completed.
- Result
Rows 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.
- Envgroup
Hostname string - Hostname is available only when query is executed at host level.
- Error string
- Error is set when query fails.
- Execution
Time string - ExecutionTime is available only after the query is completed.
- Name string
- Asynchronous Query Name.
- Query
Params GoogleCloud Apigee V1Query Metadata Response - Contains information like metrics, dimenstions etc of the AsyncQuery.
- Report
Definition stringId - Asynchronous Report ID.
- Result
Google
Cloud Apigee V1Async Query Result Response - Result is available only after the query is completed.
- Result
File stringSize - ResultFileSize is available only after the query is completed.
- Result
Rows 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.
- envgroup
Hostname String - Hostname is available only when query is executed at host level.
- error String
- Error is set when query fails.
- execution
Time String - ExecutionTime is available only after the query is completed.
- name String
- Asynchronous Query Name.
- query
Params GoogleCloud Apigee V1Query Metadata Response - Contains information like metrics, dimenstions etc of the AsyncQuery.
- report
Definition StringId - Asynchronous Report ID.
- result
Google
Cloud Apigee V1Async Query Result Response - Result is available only after the query is completed.
- result
File StringSize - ResultFileSize is available only after the query is completed.
- result
Rows 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.
- envgroup
Hostname string - Hostname is available only when query is executed at host level.
- error string
- Error is set when query fails.
- execution
Time string - ExecutionTime is available only after the query is completed.
- name string
- Asynchronous Query Name.
- query
Params GoogleCloud Apigee V1Query Metadata Response - Contains information like metrics, dimenstions etc of the AsyncQuery.
- report
Definition stringId - Asynchronous Report ID.
- result
Google
Cloud Apigee V1Async Query Result Response - Result is available only after the query is completed.
- result
File stringSize - ResultFileSize is available only after the query is completed.
- result
Rows 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 GoogleCloud Apigee V1Query Metadata Response - Contains information like metrics, dimenstions etc of the AsyncQuery.
- report_
definition_ strid - Asynchronous Report ID.
- result
Google
Cloud Apigee V1Async Query Result Response - Result is available only after the query is completed.
- result_
file_ strsize - 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.
- envgroup
Hostname String - Hostname is available only when query is executed at host level.
- error String
- Error is set when query fails.
- execution
Time String - ExecutionTime is available only after the query is completed.
- name String
- Asynchronous Query Name.
- query
Params Property Map - Contains information like metrics, dimenstions etc of the AsyncQuery.
- report
Definition StringId - Asynchronous Report ID.
- result Property Map
- Result is available only after the query is completed.
- result
File StringSize - ResultFileSize is available only after the query is completed.
- result
Rows 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
This property is required. string - Query result will be unaccessable after this time.
- Self
This property is required. 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
This property is required. string - Query result will be unaccessable after this time.
- Self
This property is required. 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
This property is required. String - Query result will be unaccessable after this time.
- self
This property is required. 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
This property is required. string - Query result will be unaccessable after this time.
- self
This property is required. 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
This property is required. str - Query result will be unaccessable after this time.
- self
This property is required. 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
This property is required. String - Query result will be unaccessable after this time.
- self
This property is required. 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
This property is required. List<string> - Dimensions of the AsyncQuery.
- End
Timestamp This property is required. string - End timestamp of the query range.
- Metrics
This property is required. List<string> - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
- Output
Format This property is required. string - Output format.
- Start
Timestamp This property is required. string - Start timestamp of the query range.
- Time
Unit This property is required. string - Query GroupBy time unit.
- Dimensions
This property is required. []string - Dimensions of the AsyncQuery.
- End
Timestamp This property is required. string - End timestamp of the query range.
- Metrics
This property is required. []string - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
- Output
Format This property is required. string - Output format.
- Start
Timestamp This property is required. string - Start timestamp of the query range.
- Time
Unit This property is required. string - Query GroupBy time unit.
- dimensions
This property is required. List<String> - Dimensions of the AsyncQuery.
- end
Timestamp This property is required. String - End timestamp of the query range.
- metrics
This property is required. List<String> - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
- output
Format This property is required. String - Output format.
- start
Timestamp This property is required. String - Start timestamp of the query range.
- time
Unit This property is required. String - Query GroupBy time unit.
- dimensions
This property is required. string[] - Dimensions of the AsyncQuery.
- end
Timestamp This property is required. string - End timestamp of the query range.
- metrics
This property is required. string[] - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
- output
Format This property is required. string - Output format.
- start
Timestamp This property is required. string - Start timestamp of the query range.
- time
Unit This property is required. string - Query GroupBy time unit.
- dimensions
This property is required. Sequence[str] - Dimensions of the AsyncQuery.
- end_
timestamp This property is required. str - End timestamp of the query range.
- metrics
This property is required. Sequence[str] - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
- output_
format This property is required. str - Output format.
- start_
timestamp This property is required. str - Start timestamp of the query range.
- time_
unit This property is required. str - Query GroupBy time unit.
- dimensions
This property is required. List<String> - Dimensions of the AsyncQuery.
- end
Timestamp This property is required. String - End timestamp of the query range.
- metrics
This property is required. List<String> - Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias:sum_message_count"]
- output
Format This property is required. String - Output format.
- start
Timestamp This property is required. String - Start timestamp of the query range.
- time
Unit This property is required. String - Query GroupBy time unit.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.