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

Class Service

java.lang.Object

software.amazon.awssdk.services.servicediscovery.model.Service

All Implemented Interfaces:

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

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

A complex type that contains information about the specified service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Service.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
static Service.Builder	builder()
Instant	createDate()	The date and time that the service was created, in Unix 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 the operation twice.
String	description()	The description of the service.
DnsConfig	dnsConfig()	A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HealthCheckConfig	healthCheckConfig()	Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.
HealthCheckCustomConfig	healthCheckCustomConfig()	A complex type that contains information about an optional custom health check.
String	id()	The ID that Cloud Map assigned to the service when you created it.
Integer	instanceCount()	The number of instances that are currently associated with the service.
String	name()	The name of the service.
String	namespaceId()	The ID of the namespace that was used to create the service.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Service.Builder>	serializableBuilderClass()
Service.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ServiceType	type()	Describes the systems that can be used to discover the service instances.
String	typeAsString()	Describes the systems that can be used to discover the service instances.

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 that Cloud Map assigned to the service when you created it.

Returns:

The ID that Cloud Map assigned to the service when you created it.

arn

public final String arn()

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

Returns:

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

name

public final String name()

The name of the service.

Returns:

The name of the service.

namespaceId

public final String namespaceId()

The ID of the namespace that was used to create the service.

Returns:

The ID of the namespace that was used to create the service.

description

public final String description()

The description of the service.

Returns:

The description of the service.

instanceCount

public final Integer instanceCount()

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

Returns:

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

dnsConfig

public final DnsConfig dnsConfig()

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

Returns:

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

type

public final ServiceType type()

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

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

Returns:

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

See Also:

ServiceType

typeAsString

public final String typeAsString()

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

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

Returns:

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

See Also:

ServiceType

healthCheckConfig

public final HealthCheckConfig healthCheckConfig()

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

For information about the charges for health checks, see Amazon Route 53 Pricing.

Returns:

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

For information about the charges for health checks, see Amazon Route 53 Pricing.

healthCheckCustomConfig

public final HealthCheckCustomConfig healthCheckCustomConfig()

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Returns:

A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

createDate

public final Instant createDate()

The date and time that the service was created, in Unix 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 and time that the service was created, in Unix 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 the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Returns:

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

toBuilder

public Service.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Service.Builder,Service>

builder

public static Service.Builder builder()

serializableBuilderClass

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