Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface PutQueryDefinitionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<PutQueryDefinitionRequest.Builder,PutQueryDefinitionRequest>, SdkBuilder<PutQueryDefinitionRequest.Builder,PutQueryDefinitionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutQueryDefinitionRequest
public static interface PutQueryDefinitionRequest.Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<PutQueryDefinitionRequest.Builder,PutQueryDefinitionRequest>

  • Method Details

    • name

      PutQueryDefinitionRequest.Builder name(String name)

      A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

      Parameters:
      name - A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryDefinitionId

      PutQueryDefinitionRequest.Builder queryDefinitionId(String queryDefinitionId)

      If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

      If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

      Parameters:
      queryDefinitionId - If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

      If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupNames

      PutQueryDefinitionRequest.Builder logGroupNames(Collection<String> logGroupNames)

      Use this parameter to include specific log groups as part of your query definition.

      If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

      Parameters:
      logGroupNames - Use this parameter to include specific log groups as part of your query definition.

      If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupNames

      PutQueryDefinitionRequest.Builder logGroupNames(String... logGroupNames)

      Use this parameter to include specific log groups as part of your query definition.

      If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

      Parameters:
      logGroupNames - Use this parameter to include specific log groups as part of your query definition.

      If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryString

      PutQueryDefinitionRequest.Builder queryString(String queryString)

      The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

      Parameters:
      queryString - The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      PutQueryDefinitionRequest.Builder clientToken(String clientToken)

      Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

      Parameters:
      clientToken - Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutQueryDefinitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutQueryDefinitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.