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

Class Namespace

java.lang.Object

software.amazon.awssdk.services.servicediscovery.model.Namespace

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Namespace.Builder,Namespace>

@Generated("software.amazon.awssdk:codegen")
public final class Namespace
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Namespace.Builder,Namespace>

A complex type that contains information about a specified namespace.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Namespace.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
static Namespace.Builder	builder()
Instant	createDate()	The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC).
String	creatorRequestId()	A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.
String	description()	The description that you specify for the namespace when you create it.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of a namespace.
String	name()	The name of the namespace, such as example.com.
NamespaceProperties	properties()	A complex type that contains information that's specific to the type of the namespace.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Namespace.Builder>	serializableBuilderClass()
Integer	serviceCount()	The number of services that are associated with the namespace.
Namespace.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
NamespaceType	type()	The type of the namespace.
String	typeAsString()	The type of the namespace.

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

id

public final String id()

The ID of a namespace.

Returns:

The ID of a namespace.

arn

public final String arn()

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

Returns:

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

name

public final String name()

The name of the namespace, such as example.com.

Returns:

The name of the namespace, such as example.com.

type

public final NamespaceType type()

The type of the namespace. The methods for discovering instances depends on the value that you specify:

HTTP

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.

DNS_PUBLIC

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

DNS_PRIVATE

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.

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

Returns:

The type of the namespace. The methods for discovering instances depends on the value that you specify:

HTTP

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.

DNS_PUBLIC

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

DNS_PRIVATE

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.

See Also:

NamespaceType

typeAsString

public final String typeAsString()

The type of the namespace. The methods for discovering instances depends on the value that you specify:

HTTP

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.

DNS_PUBLIC

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

DNS_PRIVATE

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.

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

Returns:

The type of the namespace. The methods for discovering instances depends on the value that you specify:

HTTP

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.

DNS_PUBLIC

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

DNS_PRIVATE

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.

See Also:

NamespaceType

description

public final String description()

The description that you specify for the namespace when you create it.

Returns:

The description that you specify for the namespace when you create it.

serviceCount

public final Integer serviceCount()

The number of services that are associated with the namespace.

Returns:

The number of services that are associated with the namespace.

properties

public final NamespaceProperties properties()

A complex type that contains information that's specific to the type of the namespace.

Returns:

A complex type that contains information that's specific to the type of the namespace.

createDate

public final Instant createDate()

The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

creatorRequestId

public final String creatorRequestId()

A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.

Returns:

A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.

toBuilder

public Namespace.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Namespace.Builder,Namespace>

builder

public static Namespace.Builder builder()

serializableBuilderClass

public static Class<? extends Namespace.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