java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.servicediscovery.model.ServiceDiscoveryRequest
    - - software.amazon.awssdk.services.servicediscovery.model.CreateServiceRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateServiceRequest
extends ServiceDiscoveryRequest
implements ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateServiceRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateServiceRequest.Builder`	`builder()`
`String`	`creatorRequestId()`	A unique string that identifies the request and that allows failed `CreateService` requests to be retried without the risk of running the operation twice.
`String`	`description()`	A description for the service.
`DnsConfig`	`dnsConfig()`	A complex type that contains information about the Amazon Route 53 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()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`HealthCheckConfig`	`healthCheckConfig()`	Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check.
`HealthCheckCustomConfig`	`healthCheckCustomConfig()`	A complex type that contains information about an optional custom health check.
`String`	`name()`	The name that you want to assign to the service.
`String`	`namespaceId()`	The ID of the namespace that you want to use to create the service.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateServiceRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	The tags to add to the service.
`CreateServiceRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ServiceTypeOption`	`type()`	If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.
`String`	`typeAsString()`	If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - name
```
public final String name()
```
    The name that you want to assign to the service.
    
    Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.
    
    If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:
    
    Start the name with an underscore (_), such as _exampleservice.
    
    End the name with ._protocol, such as ._tcp.
    
    When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,
    
    _exampleservice._tcp.example.com).
    
    For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.
    Returns:
    
    The name that you want to assign to the service.
    
    Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.
    
    If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:
    
    Start the name with an underscore (_), such as _exampleservice.
    
    End the name with ._protocol, such as ._tcp.
    
    When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,
    
    _exampleservice._tcp.example.com).
    
    For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.
  - namespaceId
```
public final String namespaceId()
```
    The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.
    
    Returns:
    
    The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.
  - creatorRequestId
```
public final String creatorRequestId()
```
    A unique string that identifies the request and that allows failed CreateService 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 CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
  - description
```
public final String description()
```
    A description for the service.
    
    Returns:
    
    A description for the service.
  - dnsConfig
```
public final DnsConfig dnsConfig()
```
    A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.
    
    Returns:
    
    A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you register an instance.
  - healthCheckConfig
```
public final HealthCheckConfig healthCheckConfig()
```
    Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.
    
    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
    
    For information about the charges for health checks, see Cloud Map Pricing.
    
    Returns:
    
    Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.
    
    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
    
    For information about the charges for health checks, see Cloud Map 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.
    
    You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.
    
    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.
    
    You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
  - type
```
public final ServiceTypeOption type()
```
    If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ServiceTypeOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
    
    See Also:
    
    ServiceTypeOption
  - typeAsString
```
public final String typeAsString()
```
    If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ServiceTypeOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.
    
    See Also:
    
    ServiceTypeOption
  - toBuilder
```
public CreateServiceRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
    
    Specified by:
    
    toBuilder in class ServiceDiscoveryRequest
  - builder
```
public static CreateServiceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateServiceRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - 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

Class CreateServiceRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

namespaceId

creatorRequestId

description

dnsConfig

healthCheckConfig

healthCheckCustomConfig

hasTags

tags

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField