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

Class ServiceSummary

java.lang.Object

software.amazon.awssdk.services.servicediscovery.model.ServiceSummary

All Implemented Interfaces:

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

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

A complex type that contains information about a specified service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServiceSummary.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 ServiceSummary.Builder	builder()
Instant	createDate()	The date and time that the service was created.
String	description()	The description that you specify when you create the service.
DnsConfig	dnsConfig()	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. Settings for an optional health check.
HealthCheckCustomConfig	healthCheckCustomConfig()	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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceSummary.Builder>	serializableBuilderClass()
ServiceSummary.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.

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

description

public final String description()

The description that you specify when you create the service.

Returns:

The description that you specify when you create 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()

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

Returns:

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

healthCheckConfig

public final HealthCheckConfig healthCheckConfig()

Public DNS and HTTP namespaces only. 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.

Returns:

Public DNS and HTTP namespaces only. 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.

healthCheckCustomConfig

public final HealthCheckCustomConfig healthCheckCustomConfig()

Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

• You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

• You want to use a third-party health checker regardless of where your resources are located.

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

Returns:

Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

• You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

• You want to use a third-party health checker regardless of where your resources are located.

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.

Returns:

The date and time that the service was created.

toBuilder

public ServiceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceSummary.Builder,ServiceSummary>

builder

public static ServiceSummary.Builder builder()

serializableBuilderClass

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