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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NamespaceFilter.Builder

Method Summary

Modifier and Type	Method	Description
static NamespaceFilter.Builder	builder()
FilterCondition	condition()	Specify the operator that you want to use to determine whether a namespace matches the specified value.
String	conditionAsString()	Specify the operator that you want to use to determine whether a namespace matches the specified value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
NamespaceFilterName	name()	Specify the namespaces that you want to get using one of the following.
String	nameAsString()	Specify the namespaces that you want to get using one of the following.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NamespaceFilter.Builder>	serializableBuilderClass()
NamespaceFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	Specify the values that are applicable to the value that you specify for Name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

NamespaceFilterName

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:

NamespaceFilterName

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:

FilterCondition

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:

FilterCondition

toBuilder

public NamespaceFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NamespaceFilter.Builder,NamespaceFilter>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo