Class ListTrafficPolicyInstancesByPolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.route53.model.Route53Request
software.amazon.awssdk.services.route53.model.ListTrafficPolicyInstancesByPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListTrafficPolicyInstancesByPolicyRequest.Builder,ListTrafficPolicyInstancesByPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTrafficPolicyInstancesByPolicyRequest extends Route53Request implements ToCopyableBuilder<ListTrafficPolicyInstancesByPolicyRequest.Builder,ListTrafficPolicyInstancesByPolicyRequest>

A complex type that contains the information about the request to list your traffic policy instances.

  • Method Details

    • trafficPolicyId

      public final String trafficPolicyId()

      The ID of the traffic policy for which you want to list traffic policy instances.

      Returns:
      The ID of the traffic policy for which you want to list traffic policy instances.

    • trafficPolicyVersion

      public final Integer trafficPolicyVersion()

      The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

      Returns:
      The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

    • hostedZoneIdMarker

      public final String hostedZoneIdMarker()

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      Returns:
      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • trafficPolicyInstanceNameMarker

      public final String trafficPolicyInstanceNameMarker()

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      Returns:
      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • trafficPolicyInstanceTypeMarker

      public final RRType trafficPolicyInstanceTypeMarker()

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      If the service returns an enum value that is not available in the current SDK version, trafficPolicyInstanceTypeMarker will return RRType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficPolicyInstanceTypeMarkerAsString().

      Returns:
      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      See Also:

    • trafficPolicyInstanceTypeMarkerAsString

      public final String trafficPolicyInstanceTypeMarkerAsString()

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      If the service returns an enum value that is not available in the current SDK version, trafficPolicyInstanceTypeMarker will return RRType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficPolicyInstanceTypeMarkerAsString().

      Returns:
      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      See Also:

    • maxItems

      public final String maxItems()

      The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      Returns:
      The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    • toBuilder

      public ListTrafficPolicyInstancesByPolicyRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListTrafficPolicyInstancesByPolicyRequest.Builder,ListTrafficPolicyInstancesByPolicyRequest>
      Specified by:
      toBuilder in class Route53Request
      Returns:
      a builder for type T

    • builder

      public static ListTrafficPolicyInstancesByPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListTrafficPolicyInstancesByPolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.