software.amazon.awssdk.services.servicediscovery.model

Class RegisterInstanceRequest

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

All Implemented Interfaces:

ToCopyableBuilder<RegisterInstanceRequest.Builder,RegisterInstanceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() A string map that contain attribute keys and values.
static RegisterInstanceRequest.Builder	builder()
String	creatorRequestId() An optional parameter that you can use to resolve concurrent creation requests.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	instanceId() An identifier that you want to associate with the instance.
static Class<? extends RegisterInstanceRequest.Builder>	serializableBuilderClass()
String	serviceId() The ID of the service that you want to use for settings for the resource record sets and health check that Amazon Route 53 will create.
RegisterInstanceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

serviceId

public String serviceId()

The ID of the service that you want to use for settings for the resource record sets and health check that Amazon Route 53 will create.

Returns:

The ID of the service that you want to use for settings for the resource record sets and health check that Amazon Route 53 will create.

instanceId

public String instanceId()

An identifier that you want to associate with the instance. Note the following:

• You can use this value to update an existing instance.

• To register a new instance, you must specify a value that is unique among instances that you register by using the same service.

Returns:

An identifier that you want to associate with the instance. Note the following:

• You can use this value to update an existing instance.

• To register a new instance, you must specify a value that is unique among instances that you register by using the same service.

creatorRequestId

public String creatorRequestId()

An optional parameter that you can use to resolve concurrent creation requests. CreatorRequestId helps to determine if a specific client owns the namespace.

Returns:

An optional parameter that you can use to resolve concurrent creation requests. CreatorRequestId helps to determine if a specific client owns the namespace.

attributes

public Map<String,String> attributes()

A string map that contain attribute keys and values. Supported attribute keys include the following:

• AWS_INSTANCE_PORT: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. For more information, see CreateService.

• AWS_INSTANCE_IPV4: If the service that you specify contains a resource record set template for an A record, the IPv4 address that you want Amazon Route 53 to use for the value of the A record.

• AWS_INSTANCE_IPV6: If the service that you specify contains a resource record set template for an AAAA record, the IPv6 address that you want Amazon Route 53 to use for the value of the AAAA record.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A string map that contain attribute keys and values. Supported attribute keys include the following:

• AWS_INSTANCE_PORT: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. For more information, see CreateService.

• AWS_INSTANCE_IPV4: If the service that you specify contains a resource record set template for an A record, the IPv4 address that you want Amazon Route 53 to use for the value of the A record.

• AWS_INSTANCE_IPV6: If the service that you specify contains a resource record set template for an AAAA record, the IPv6 address that you want Amazon Route 53 to use for the value of the AAAA record.

toBuilder

public RegisterInstanceRequest.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<RegisterInstanceRequest.Builder,RegisterInstanceRequest>

Specified by:

toBuilder in class ServiceDiscoveryRequest

Returns:

a builder for type T

builder

public static RegisterInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RegisterInstanceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value