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:

  • Method Details

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

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

    • 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()
      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<ServiceSummary.Builder,ServiceSummary>
      Returns:
      a builder for type T

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