Interface DescribeInstanceSqlHaHistoryStatesRequest.Builder

    • Method Detail

      • instanceIds

        DescribeInstanceSqlHaHistoryStatesRequest.Builder instanceIds​(Collection<String> instanceIds)

        The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.

        Parameters:
        instanceIds - The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • instanceIds

        DescribeInstanceSqlHaHistoryStatesRequest.Builder instanceIds​(String... instanceIds)

        The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.

        Parameters:
        instanceIds - The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • startTime

        DescribeInstanceSqlHaHistoryStatesRequest.Builder startTime​(Instant startTime)

        The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states.

        Timezone: UTC

        Format: YYYY-MM-DDThh:mm:ss.sssZ

        Parameters:
        startTime - The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states.

        Timezone: UTC

        Format: YYYY-MM-DDThh:mm:ss.sssZ

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

        DescribeInstanceSqlHaHistoryStatesRequest.Builder endTime​(Instant endTime)

        The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time.

        Timezone: UTC

        Format: YYYY-MM-DDThh:mm:ss.sssZ

        Parameters:
        endTime - The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time.

        Timezone: UTC

        Format: YYYY-MM-DDThh:mm:ss.sssZ

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

        DescribeInstanceSqlHaHistoryStatesRequest.Builder nextToken​(String nextToken)

        The token to use to retrieve the next page of results.

        Parameters:
        nextToken - The token to use to retrieve the next page of results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • maxResults

        DescribeInstanceSqlHaHistoryStatesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

        Parameters:
        maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • filters

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

        One or more filters to apply to the results. Supported filters include:

        • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The tag key assigned to the instance.

        • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

        • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

        Parameters:
        filters - One or more filters to apply to the results. Supported filters include:

        • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The tag key assigned to the instance.

        • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid ).

        • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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

        DescribeInstanceSqlHaHistoryStatesRequest.Builder filters​(Filter... filters)

        One or more filters to apply to the results. Supported filters include:

        • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The tag key assigned to the instance.

        • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

        • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

        Parameters:
        filters - One or more filters to apply to the results. Supported filters include:

        • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The tag key assigned to the instance.

        • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid ).

        • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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

        DescribeInstanceSqlHaHistoryStatesRequest.Builder filters​(Consumer<Filter.Builder>... filters)

        One or more filters to apply to the results. Supported filters include:

        • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • tag-key - The tag key assigned to the instance.

        • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

        • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

        Parameters:
        filters - a consumer that will call methods on Filter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filters(java.util.Collection)
      • dryRun

        DescribeInstanceSqlHaHistoryStatesRequest.Builder dryRun​(Boolean dryRun)

        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

        Parameters:
        dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.