Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. HostQuery

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigee/v1.HostQuery

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of “enqueued” means that the request succeeded. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create HostQuery Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HostQuery(name: string, args: HostQueryArgs, opts?: CustomResourceOptions);
    @overload
def HostQuery(resource_name: str,
              args: HostQueryArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def HostQuery(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              organization_id: Optional[str] = None,
              time_range: Optional[Any] = None,
              csv_delimiter: Optional[str] = None,
              dimensions: Optional[Sequence[str]] = None,
              envgroup_hostname: Optional[str] = None,
              filter: Optional[str] = None,
              group_by_time_unit: Optional[str] = None,
              limit: Optional[int] = None,
              metrics: Optional[Sequence[GoogleCloudApigeeV1QueryMetricArgs]] = None,
              name: Optional[str] = None,
              output_format: Optional[str] = None,
              report_definition_id: Optional[str] = None)
    func NewHostQuery(ctx *Context, name string, args HostQueryArgs, opts ...ResourceOption) (*HostQuery, error)
    public HostQuery(string name, HostQueryArgs args, CustomResourceOptions? opts = null)
    public HostQuery(String name, HostQueryArgs args)
public HostQuery(String name, HostQueryArgs args, CustomResourceOptions options)

    type: google-native:apigee/v1:HostQuery
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args HostQueryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HostQueryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HostQueryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostQueryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostQueryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hostQueryResource = new GoogleNative.Apigee.V1.HostQuery("hostQueryResource", new()
{
    OrganizationId = "string",
    TimeRange = "any",
    CsvDelimiter = "string",
    Dimensions = new[]
    {
        "string",
    },
    EnvgroupHostname = "string",
    Filter = "string",
    GroupByTimeUnit = "string",
    Limit = 0,
    Metrics = new[]
    {
        new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1QueryMetricArgs
        {
            Name = "string",
            Alias = "string",
            Function = "string",
            Operator = "string",
            Value = "string",
        },
    },
    Name = "string",
    OutputFormat = "string",
    ReportDefinitionId = "string",
});

    example, err := apigee.NewHostQuery(ctx, "hostQueryResource", &apigee.HostQueryArgs{
	OrganizationId: pulumi.String("string"),
	TimeRange:      pulumi.Any("any"),
	CsvDelimiter:   pulumi.String("string"),
	Dimensions: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnvgroupHostname: pulumi.String("string"),
	Filter:           pulumi.String("string"),
	GroupByTimeUnit:  pulumi.String("string"),
	Limit:            pulumi.Int(0),
	Metrics: apigee.GoogleCloudApigeeV1QueryMetricArray{
		&apigee.GoogleCloudApigeeV1QueryMetricArgs{
			Name:     pulumi.String("string"),
			Alias:    pulumi.String("string"),
			Function: pulumi.String("string"),
			Operator: pulumi.String("string"),
			Value:    pulumi.String("string"),
		},
	},
	Name:               pulumi.String("string"),
	OutputFormat:       pulumi.String("string"),
	ReportDefinitionId: pulumi.String("string"),
})

    var hostQueryResource = new HostQuery("hostQueryResource", HostQueryArgs.builder()
    .organizationId("string")
    .timeRange("any")
    .csvDelimiter("string")
    .dimensions("string")
    .envgroupHostname("string")
    .filter("string")
    .groupByTimeUnit("string")
    .limit(0)
    .metrics(GoogleCloudApigeeV1QueryMetricArgs.builder()
        .name("string")
        .alias("string")
        .function("string")
        .operator("string")
        .value("string")
        .build())
    .name("string")
    .outputFormat("string")
    .reportDefinitionId("string")
    .build());

    host_query_resource = google_native.apigee.v1.HostQuery("hostQueryResource",
    organization_id="string",
    time_range="any",
    csv_delimiter="string",
    dimensions=["string"],
    envgroup_hostname="string",
    filter="string",
    group_by_time_unit="string",
    limit=0,
    metrics=[google_native.apigee.v1.GoogleCloudApigeeV1QueryMetricArgs(
        name="string",
        alias="string",
        function="string",
        operator="string",
        value="string",
    )],
    name="string",
    output_format="string",
    report_definition_id="string")

    const hostQueryResource = new google_native.apigee.v1.HostQuery("hostQueryResource", {
    organizationId: "string",
    timeRange: "any",
    csvDelimiter: "string",
    dimensions: ["string"],
    envgroupHostname: "string",
    filter: "string",
    groupByTimeUnit: "string",
    limit: 0,
    metrics: [{
        name: "string",
        alias: "string",
        "function": "string",
        operator: "string",
        value: "string",
    }],
    name: "string",
    outputFormat: "string",
    reportDefinitionId: "string",
});

    type: google-native:apigee/v1:HostQuery
properties:
    csvDelimiter: string
    dimensions:
        - string
    envgroupHostname: string
    filter: string
    groupByTimeUnit: string
    limit: 0
    metrics:
        - alias: string
          function: string
          name: string
          operator: string
          value: string
    name: string
    organizationId: string
    outputFormat: string
    reportDefinitionId: string
    timeRange: any

    HostQuery Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The HostQuery resource accepts the following input properties:

    OrganizationId string
    TimeRange object
    Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    CsvDelimiter string
    Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    Dimensions List<string>
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
    EnvgroupHostname string
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    Filter string
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    GroupByTimeUnit string
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    Limit int
    Maximum number of rows that can be returned in the result.
    Metrics List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1QueryMetric>
    A list of Metrics.
    Name string
    Asynchronous Query Name.
    OutputFormat string
    Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    ReportDefinitionId string
    Asynchronous Report ID.
    OrganizationId string
    TimeRange interface{}
    Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    CsvDelimiter string
    Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    Dimensions []string
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
    EnvgroupHostname string
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    Filter string
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    GroupByTimeUnit string
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    Limit int
    Maximum number of rows that can be returned in the result.
    Metrics []GoogleCloudApigeeV1QueryMetricArgs
    A list of Metrics.
    Name string
    Asynchronous Query Name.
    OutputFormat string
    Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    ReportDefinitionId string
    Asynchronous Report ID.
    organizationId String
    timeRange Object
    Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    csvDelimiter String
    Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    dimensions List<String>
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
    envgroupHostname String
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    filter String
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    groupByTimeUnit String
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    limit Integer
    Maximum number of rows that can be returned in the result.
    metrics List<GoogleCloudApigeeV1QueryMetric>
    A list of Metrics.
    name String
    Asynchronous Query Name.
    outputFormat String
    Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    reportDefinitionId String
    Asynchronous Report ID.
    organizationId string
    timeRange any
    Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    csvDelimiter string
    Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    dimensions string[]
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
    envgroupHostname string
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    filter string
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    groupByTimeUnit string
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    limit number
    Maximum number of rows that can be returned in the result.
    metrics GoogleCloudApigeeV1QueryMetric[]
    A list of Metrics.
    name string
    Asynchronous Query Name.
    outputFormat string
    Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    reportDefinitionId string
    Asynchronous Report ID.
    organization_id str
    time_range Any
    Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    csv_delimiter str
    Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    dimensions Sequence[str]
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
    envgroup_hostname str
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    filter str
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    group_by_time_unit str
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    limit int
    Maximum number of rows that can be returned in the result.
    metrics Sequence[GoogleCloudApigeeV1QueryMetricArgs]
    A list of Metrics.
    name str
    Asynchronous Query Name.
    output_format str
    Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    report_definition_id str
    Asynchronous Report ID.
    organizationId String
    timeRange Any
    Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    csvDelimiter String
    Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    dimensions List<String>
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
    envgroupHostname String
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    filter String
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    groupByTimeUnit String
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    limit Number
    Maximum number of rows that can be returned in the result.
    metrics List<Property Map>
    A list of Metrics.
    name String
    Asynchronous Query Name.
    outputFormat String
    Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    reportDefinitionId String
    Asynchronous Report ID.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HostQuery resource produces the following output properties:

    Created string
    Creation time of the query.
    Error string
    Error is set when query fails.
    ExecutionTime string
    ExecutionTime is available only after the query is completed.
    Id string
    The provider-assigned unique ID for this managed resource.
    QueryParams Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1QueryMetadataResponse
    Contains information like metrics, dimenstions etc of the AsyncQuery.
    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.
    Error string
    Error is set when query fails.
    ExecutionTime string
    ExecutionTime is available only after the query is completed.
    Id string
    The provider-assigned unique ID for this managed resource.
    QueryParams GoogleCloudApigeeV1QueryMetadataResponse
    Contains information like metrics, dimenstions etc of the AsyncQuery.
    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.
    error String
    Error is set when query fails.
    executionTime String
    ExecutionTime is available only after the query is completed.
    id String
    The provider-assigned unique ID for this managed resource.
    queryParams GoogleCloudApigeeV1QueryMetadataResponse
    Contains information like metrics, dimenstions etc of the AsyncQuery.
    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.
    error string
    Error is set when query fails.
    executionTime string
    ExecutionTime is available only after the query is completed.
    id string
    The provider-assigned unique ID for this managed resource.
    queryParams GoogleCloudApigeeV1QueryMetadataResponse
    Contains information like metrics, dimenstions etc of the AsyncQuery.
    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.
    error str
    Error is set when query fails.
    execution_time str
    ExecutionTime is available only after the query is completed.
    id str
    The provider-assigned unique ID for this managed resource.
    query_params GoogleCloudApigeeV1QueryMetadataResponse
    Contains information like metrics, dimenstions etc of the AsyncQuery.
    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.
    error String
    Error is set when query fails.
    executionTime String
    ExecutionTime is available only after the query is completed.
    id String
    The provider-assigned unique ID for this managed resource.
    queryParams Property Map
    Contains information like metrics, dimenstions etc of the AsyncQuery.
    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, GoogleCloudApigeeV1AsyncQueryResultResponseArgs

    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, GoogleCloudApigeeV1QueryMetadataResponseArgs

    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.

    GoogleCloudApigeeV1QueryMetric, GoogleCloudApigeeV1QueryMetricArgs

    Name string
    Metric name.
    Alias string
    Alias for the metric. Alias will be used to replace metric name in query results.
    Function string
    Aggregation function: avg, min, max, or sum.
    Operator string
    One of +, -, /, %, *.
    Value string
    Operand value should be provided when operator is set.
    Name string
    Metric name.
    Alias string
    Alias for the metric. Alias will be used to replace metric name in query results.
    Function string
    Aggregation function: avg, min, max, or sum.
    Operator string
    One of +, -, /, %, *.
    Value string
    Operand value should be provided when operator is set.
    name String
    Metric name.
    alias String
    Alias for the metric. Alias will be used to replace metric name in query results.
    function String
    Aggregation function: avg, min, max, or sum.
    operator String
    One of +, -, /, %, *.
    value String
    Operand value should be provided when operator is set.
    name string
    Metric name.
    alias string
    Alias for the metric. Alias will be used to replace metric name in query results.
    function string
    Aggregation function: avg, min, max, or sum.
    operator string
    One of +, -, /, %, *.
    value string
    Operand value should be provided when operator is set.
    name str
    Metric name.
    alias str
    Alias for the metric. Alias will be used to replace metric name in query results.
    function str
    Aggregation function: avg, min, max, or sum.
    operator str
    One of +, -, /, %, *.
    value str
    Operand value should be provided when operator is set.
    name String
    Metric name.
    alias String
    Alias for the metric. Alias will be used to replace metric name in query results.
    function String
    Aggregation function: avg, min, max, or sum.
    operator String
    One of +, -, /, %, *.
    value String
    Operand value should be provided when operator is set.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native