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:

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

    • resourceOwner

      public final String resourceOwner()

      The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

      Returns:
      The ID of the Amazon Web Services account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

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

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

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

    • createdByAccount

      public final String createdByAccount()

      The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is the ID of account of the namespace owner or of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

      Returns:
      The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is the ID of account of the namespace owner or of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

    • toBuilder

      public Service.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<Service.Builder,Service>
      Returns:
      a builder for type T

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.