Package software.amazon.awssdk.services.servicediscovery.model

Class NamespaceFilter

java.lang.Object
software.amazon.awssdk.services.servicediscovery.model.NamespaceFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NamespaceFilter.Builder,NamespaceFilter>
@Generated("software.amazon.awssdk:codegen") public final class NamespaceFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NamespaceFilter.Builder,NamespaceFilter>

A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

See Also:

  • Method Details

    • name

      public final NamespaceFilterName name()

      Specify the namespaces that you want to get using one of the following.

      • TYPE: Gets the namespaces of the specified type.

      • NAME: Gets the namespaces with the specified name.

      • HTTP_NAME: Gets the namespaces with the specified HTTP name.

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

      Returns:
      Specify the namespaces that you want to get using one of the following.

      • TYPE: Gets the namespaces of the specified type.

      • NAME: Gets the namespaces with the specified name.

      • HTTP_NAME: Gets the namespaces with the specified HTTP name.

      See Also:

    • nameAsString

      public final String nameAsString()

      Specify the namespaces that you want to get using one of the following.

      • TYPE: Gets the namespaces of the specified type.

      • NAME: Gets the namespaces with the specified name.

      • HTTP_NAME: Gets the namespaces with the specified HTTP name.

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

      Returns:
      Specify the namespaces that you want to get using one of the following.

      • TYPE: Gets the namespaces of the specified type.

      • NAME: Gets the namespaces with the specified name.

      • HTTP_NAME: Gets the namespaces with the specified HTTP name.

      See Also:

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • values

      public final List<String> values()

      Specify the values that are applicable to the value that you specify for Name.

      • TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE.

      • NAME: Specify the name of the namespace, which is found in Namespace.Name.

      • HTTP_NAME: Specify the HTTP name of the namespace, which is found in Namespace.Properties.HttpProperties.HttpName.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      Returns:
      Specify the values that are applicable to the value that you specify for Name.

      • TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE.

      • NAME: Specify the name of the namespace, which is found in Namespace.Name.

      • HTTP_NAME: Specify the HTTP name of the namespace, which is found in Namespace.Properties.HttpProperties.HttpName.

    • condition

      public final FilterCondition condition()

      Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

      • EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.

      • BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.

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

      Returns:
      Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

      • EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.

      • BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.

      See Also:

    • conditionAsString

      public final String conditionAsString()

      Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

      • EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.

      • BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.

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

      Returns:
      Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

      • EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.

      • BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.

      See Also:

    • toBuilder

      public NamespaceFilter.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<NamespaceFilter.Builder,NamespaceFilter>
      Returns:
      a builder for type T

    • builder

      public static NamespaceFilter.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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