Interface GetScheduledQueryResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CloudWatchLogsResponse.Builder, CopyableBuilder<GetScheduledQueryResponse.Builder,GetScheduledQueryResponse>, SdkBuilder<GetScheduledQueryResponse.Builder,GetScheduledQueryResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetScheduledQueryResponse
@Mutable @NotThreadSafe public static interface GetScheduledQueryResponse.Builder extends CloudWatchLogsResponse.Builder, SdkPojo, CopyableBuilder<GetScheduledQueryResponse.Builder,GetScheduledQueryResponse>

  • Method Details

    • scheduledQueryArn

      GetScheduledQueryResponse.Builder scheduledQueryArn(String scheduledQueryArn)

      The Amazon Resource Name (ARN) of the scheduled query.

      Parameters:
      scheduledQueryArn - The Amazon Resource Name (ARN) of the scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetScheduledQueryResponse.Builder name(String name)

      The name of the scheduled query.

      Parameters:
      name - The name of the scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GetScheduledQueryResponse.Builder description(String description)

      The description of the scheduled query.

      Parameters:
      description - The description of the scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryLanguage

      GetScheduledQueryResponse.Builder queryLanguage(String queryLanguage)

      The query language used by the scheduled query (LogsQL, PPL, or SQL).

      Parameters:
      queryLanguage - The query language used by the scheduled query (LogsQL, PPL, or SQL).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryLanguage

      GetScheduledQueryResponse.Builder queryLanguage(QueryLanguage queryLanguage)

      The query language used by the scheduled query (LogsQL, PPL, or SQL).

      Parameters:
      queryLanguage - The query language used by the scheduled query (LogsQL, PPL, or SQL).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryString

      GetScheduledQueryResponse.Builder queryString(String queryString)

      The CloudWatch Logs Insights query string being executed.

      Parameters:
      queryString - The CloudWatch Logs Insights query string being executed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupIdentifiers

      GetScheduledQueryResponse.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

      The log group identifiers being queried by the scheduled query.

      Parameters:
      logGroupIdentifiers - The log group identifiers being queried by the scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupIdentifiers

      GetScheduledQueryResponse.Builder logGroupIdentifiers(String... logGroupIdentifiers)

      The log group identifiers being queried by the scheduled query.

      Parameters:
      logGroupIdentifiers - The log group identifiers being queried by the scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      GetScheduledQueryResponse.Builder scheduleExpression(String scheduleExpression)

      The cron expression that defines when the scheduled query runs.

      Parameters:
      scheduleExpression - The cron expression that defines when the scheduled query runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timezone

      GetScheduledQueryResponse.Builder timezone(String timezone)

      The timezone in which the schedule expression is evaluated.

      Parameters:
      timezone - The timezone in which the schedule expression is evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimeOffset

      GetScheduledQueryResponse.Builder startTimeOffset(Long startTimeOffset)

      Time offset in seconds from the execution time for the start of the query time range.

      Parameters:
      startTimeOffset - Time offset in seconds from the execution time for the start of the query time range.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationConfiguration

      GetScheduledQueryResponse.Builder destinationConfiguration(DestinationConfiguration destinationConfiguration)

      Configuration for destinations where the query results are delivered.

      Parameters:
      destinationConfiguration - Configuration for destinations where the query results are delivered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationConfiguration

      default GetScheduledQueryResponse.Builder destinationConfiguration(Consumer<DestinationConfiguration.Builder> destinationConfiguration)

      Configuration for destinations where the query results are delivered.

      This is a convenience method that creates an instance of the DestinationConfiguration.Builder avoiding the need to create one manually via DestinationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationConfiguration(DestinationConfiguration).

      Parameters:
      destinationConfiguration - a consumer that will call methods on DestinationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      GetScheduledQueryResponse.Builder state(String state)

      The current state of the scheduled query (ENABLED or DISABLED).

      Parameters:
      state - The current state of the scheduled query (ENABLED or DISABLED).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      GetScheduledQueryResponse.Builder state(ScheduledQueryState state)

      The current state of the scheduled query (ENABLED or DISABLED).

      Parameters:
      state - The current state of the scheduled query (ENABLED or DISABLED).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastTriggeredTime

      GetScheduledQueryResponse.Builder lastTriggeredTime(Long lastTriggeredTime)

      The time when the scheduled query was last executed, in Unix epoch time.

      Parameters:
      lastTriggeredTime - The time when the scheduled query was last executed, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastExecutionStatus

      GetScheduledQueryResponse.Builder lastExecutionStatus(String lastExecutionStatus)

      The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).

      Parameters:
      lastExecutionStatus - The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastExecutionStatus

      GetScheduledQueryResponse.Builder lastExecutionStatus(ExecutionStatus lastExecutionStatus)

      The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).

      Parameters:
      lastExecutionStatus - The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleStartTime

      GetScheduledQueryResponse.Builder scheduleStartTime(Long scheduleStartTime)

      The start time for the query schedule in Unix epoch time.

      Parameters:
      scheduleStartTime - The start time for the query schedule in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleEndTime

      GetScheduledQueryResponse.Builder scheduleEndTime(Long scheduleEndTime)

      The end time for the query schedule in Unix epoch time.

      Parameters:
      scheduleEndTime - The end time for the query schedule in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleArn

      GetScheduledQueryResponse.Builder executionRoleArn(String executionRoleArn)

      The ARN of the IAM role used to execute the scheduled query.

      Parameters:
      executionRoleArn - The ARN of the IAM role used to execute the scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      GetScheduledQueryResponse.Builder creationTime(Long creationTime)

      The time when the scheduled query was created, in Unix epoch time.

      Parameters:
      creationTime - The time when the scheduled query was created, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedTime

      GetScheduledQueryResponse.Builder lastUpdatedTime(Long lastUpdatedTime)

      The time when the scheduled query was last updated, in Unix epoch time.

      Parameters:
      lastUpdatedTime - The time when the scheduled query was last updated, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.