Interface Service.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Service.Builder,Service>,SdkBuilder<Service.Builder,Service>,SdkPojo
- Enclosing class:
- Service
public static interface Service.Builder extends SdkPojo, CopyableBuilder<Service.Builder,Service>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Service.Builderarn(String arn)The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.Service.BuildercreateDate(Instant createDate)The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC).Service.BuildercreatorRequestId(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.Service.Builderdescription(String description)The description of the service.default Service.BuilderdnsConfig(Consumer<DnsConfig.Builder> 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.Service.BuilderdnsConfig(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.default Service.BuilderhealthCheckConfig(Consumer<HealthCheckConfig.Builder> healthCheckConfig)Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.Service.BuilderhealthCheckConfig(HealthCheckConfig healthCheckConfig)Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.default Service.BuilderhealthCheckCustomConfig(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig)A complex type that contains information about an optional custom health check.Service.BuilderhealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig)A complex type that contains information about an optional custom health check.Service.Builderid(String id)The ID that Cloud Map assigned to the service when you created it.Service.BuilderinstanceCount(Integer instanceCount)The number of instances that are currently associated with the service.Service.Buildername(String name)The name of the service.Service.BuildernamespaceId(String namespaceId)The ID of the namespace that was used to create the service.Service.Buildertype(String type)Describes the systems that can be used to discover the service instances.Service.Buildertype(ServiceType type)Describes the systems that can be used to discover the service instances.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
id
Service.Builder id(String id)
The ID that Cloud Map assigned to the service when you created it.
- Parameters:
id- The ID that Cloud Map assigned to the service when you created it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
Service.Builder arn(String arn)
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
- Parameters:
arn- The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
Service.Builder name(String name)
The name of the service.
- Parameters:
name- The name of the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
namespaceId
Service.Builder namespaceId(String namespaceId)
The ID of the namespace that was used to create the service.
- Parameters:
namespaceId- The ID of the namespace that was used to create the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
Service.Builder description(String description)
The description of the service.
- Parameters:
description- The description of the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceCount
Service.Builder instanceCount(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
dnsConfig
Service.Builder dnsConfig(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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
dnsConfig
default Service.Builder dnsConfig(Consumer<DnsConfig.Builder> 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.
This is a convenience method that creates an instance of theThe record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig.DnsConfig.Builderavoiding the need to create one manually viaDnsConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todnsConfig(DnsConfig).- Parameters:
dnsConfig- a consumer that will call methods onDnsConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
dnsConfig(DnsConfig)
-
type
Service.Builder type(String 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
DiscoverInstancesAPI operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
-
Reserved.
- Parameters:
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
DiscoverInstancesAPI operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
-
Reserved.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ServiceType,ServiceType
-
type
Service.Builder type(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
DiscoverInstancesAPI operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
-
Reserved.
- Parameters:
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
DiscoverInstancesAPI operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
-
Reserved.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ServiceType,ServiceType
-
healthCheckConfig
Service.Builder healthCheckConfig(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.
- Parameters:
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 inDnsConfig.For information about the charges for health checks, see Amazon Route 53 Pricing.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckConfig
default Service.Builder healthCheckConfig(Consumer<HealthCheckConfig.Builder> 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.
This is a convenience method that creates an instance of theHealthCheckConfig.Builderavoiding the need to create one manually viaHealthCheckConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohealthCheckConfig(HealthCheckConfig).- Parameters:
healthCheckConfig- a consumer that will call methods onHealthCheckConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
healthCheckConfig(HealthCheckConfig)
-
healthCheckCustomConfig
Service.Builder healthCheckCustomConfig(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
HealthCheckCustomConfigorHealthCheckConfigbut not both.- Parameters:
healthCheckCustomConfig- A complex type that contains information about an optional custom health check.If you specify a health check configuration, you can specify either
HealthCheckCustomConfigorHealthCheckConfigbut not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckCustomConfig
default Service.Builder healthCheckCustomConfig(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig)
A complex type that contains information about an optional custom health check.
This is a convenience method that creates an instance of theIf you specify a health check configuration, you can specify either
HealthCheckCustomConfigorHealthCheckConfigbut not both.HealthCheckCustomConfig.Builderavoiding the need to create one manually viaHealthCheckCustomConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohealthCheckCustomConfig(HealthCheckCustomConfig).- Parameters:
healthCheckCustomConfig- a consumer that will call methods onHealthCheckCustomConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
healthCheckCustomConfig(HealthCheckCustomConfig)
-
createDate
Service.Builder createDate(Instant createDate)
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of
CreateDateis accurate to milliseconds. For example, the value1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.- Parameters:
createDate- The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value ofCreateDateis accurate to milliseconds. For example, the value1516925490.087represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creatorRequestId
Service.Builder creatorRequestId(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.
CreatorRequestIdcan be any unique string (for example, a date/timestamp).- Parameters:
creatorRequestId- A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.CreatorRequestIdcan be any unique string (for example, a date/timestamp).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-