Package software.amazon.awssdk.services.redshift.model

Interface DescribeEventsRequest.Builder

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

  • Method Details

    • sourceIdentifier

      DescribeEventsRequest.Builder sourceIdentifier(String sourceIdentifier)

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      • Specify a cluster identifier when SourceType is cluster.

      • Specify a cluster security group name when SourceType is cluster-security-group.

      • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

      • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

      Parameters:
      sourceIdentifier - The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      • Specify a cluster identifier when SourceType is cluster.

      • Specify a cluster security group name when SourceType is cluster-security-group.

      • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

      • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

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

    • sourceType

      DescribeEventsRequest.Builder sourceType(String sourceType)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      • Specify cluster when SourceIdentifier is a cluster identifier.

      • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

      • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

      • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

      Parameters:
      sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      • Specify cluster when SourceIdentifier is a cluster identifier.

      • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

      • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

      • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

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

    • sourceType

      DescribeEventsRequest.Builder sourceType(SourceType sourceType)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      • Specify cluster when SourceIdentifier is a cluster identifier.

      • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

      • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

      • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

      Parameters:
      sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      • Specify cluster when SourceIdentifier is a cluster identifier.

      • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

      • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

      • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

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

    • startTime

      DescribeEventsRequest.Builder startTime(Instant startTime)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

      Parameters:
      startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

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

    • endTime

      DescribeEventsRequest.Builder endTime(Instant endTime)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

      Parameters:
      endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

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

    • duration

      DescribeEventsRequest.Builder duration(Integer duration)

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: 60

      Parameters:
      duration - The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: 60

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

    • maxRecords

      DescribeEventsRequest.Builder maxRecords(Integer maxRecords)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

      Parameters:
      maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

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

    • marker

      DescribeEventsRequest.Builder marker(String marker)

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Parameters:
      marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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