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

Interface PutQueryDefinitionRequest.Builder

    • Method Detail

      • queryLanguage

        PutQueryDefinitionRequest.Builder queryLanguage​(String queryLanguage)

        Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

        Parameters:
        queryLanguage - Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryLanguage, QueryLanguage

      • queryLanguage

        PutQueryDefinitionRequest.Builder queryLanguage​(QueryLanguage queryLanguage)

        Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

        Parameters:
        queryLanguage - Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryLanguage, QueryLanguage

      • 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 your query uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.

        If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL 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 your query uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.

        If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL 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 your query uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.

        If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL 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 your query uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.

        If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL 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.

      • 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.