Package software.amazon.awssdk.services.networkmonitor.model

Class CreateProbeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkmonitor.model.NetworkMonitorRequest

software.amazon.awssdk.services.networkmonitor.model.CreateProbeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateProbeRequest.Builder,CreateProbeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateProbeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateProbeRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier to ensure the idempotency of the request.
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.
String	monitorName()	The name of the monitor to associated with the probe.
ProbeInput	probe()	Describes the details of an individual probe for a monitor.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProbeRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The list of key-value pairs created and assigned to the probe.
CreateProbeRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

monitorName

public final String monitorName()

The name of the monitor to associated with the probe.

Returns:

The name of the monitor to associated with the probe.

probe

public final ProbeInput probe()

Describes the details of an individual probe for a monitor.

Returns:

Describes the details of an individual probe for a monitor.

clientToken

public final String clientToken()

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

Returns:

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

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 Map<String,String> tags()

The list of key-value pairs created and assigned to the probe.

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 list of key-value pairs created and assigned to the probe.

toBuilder

public CreateProbeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProbeRequest.Builder,CreateProbeRequest>

Specified by:

toBuilder in class NetworkMonitorRequest

builder

public static CreateProbeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateProbeRequest.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