Package software.amazon.awssdk.services.docdb.model

Interface DescribeEventsRequest.Builder

    • Method Detail

      • sourceIdentifier

        DescribeEventsRequest.Builder sourceIdentifier​(String sourceIdentifier)

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

        Constraints:

        • If SourceIdentifier is provided, SourceType must also be provided.

        • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

        • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

        • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

        • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

        • Cannot end with a hyphen or contain two consecutive hyphens.

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

        Constraints:

        • If SourceIdentifier is provided, SourceType must also be provided.

        • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

        • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

        • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

        • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

        • Cannot end with a hyphen or contain two consecutive hyphens.

        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.

        Parameters:
        sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SourceType, SourceType

      • sourceType

        DescribeEventsRequest.Builder sourceType​(SourceType sourceType)

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

        Parameters:
        sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SourceType, SourceType

      • startTime

        DescribeEventsRequest.Builder startTime​(Instant startTime)

        The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

        Example: 2009-07-08T18:00Z

        Parameters:
        startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

        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.

        Example: 2009-07-08T18:00Z

        Parameters:
        endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.

        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 to retrieve events for.

        Default: 60

        Parameters:
        duration - The number of minutes to retrieve events for.

        Default: 60

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

      • eventCategories

        DescribeEventsRequest.Builder eventCategories​(Collection<String> eventCategories)

        A list of event categories that trigger notifications for an event notification subscription.

        Parameters:
        eventCategories - A list of event categories that trigger notifications for an event notification subscription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventCategories

        DescribeEventsRequest.Builder eventCategories​(String... eventCategories)

        A list of event categories that trigger notifications for an event notification subscription.

        Parameters:
        eventCategories - A list of event categories that trigger notifications for an event notification subscription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        DescribeEventsRequest.Builder filters​(Collection<Filter> filters)

        This parameter is not currently supported.

        Parameters:
        filters - This parameter is not currently supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        DescribeEventsRequest.Builder filters​(Filter... filters)

        This parameter is not currently supported.

        Parameters:
        filters - This parameter is not currently supported.
        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 records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

        Default: 100

        Constraints: Minimum 20, maximum 100.

        Parameters:
        maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

        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 pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

        Parameters:
        marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
        Returns:
        Returns a reference to this object so that method calls can be chained together.