Package software.amazon.awssdk.services.networkflowmonitor.model

Class GetMonitorResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorResponse

software.amazon.awssdk.services.networkflowmonitor.model.GetMonitorResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetMonitorResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetMonitorResponse.Builder	builder()
Instant	createdAt()	The date and time when the monitor was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLocalResources()	For responses, this returns true if the service returned a value for the LocalResources property.
boolean	hasRemoteResources()	For responses, this returns true if the service returned a value for the RemoteResources property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<MonitorLocalResource>	localResources()	The local resources for this monitor.
Instant	modifiedAt()	The date and time when the monitor was last modified.
String	monitorArn()	The Amazon Resource Name (ARN) of the monitor.
String	monitorName()	The name of the monitor.
MonitorStatus	monitorStatus()	The status of a monitor.
String	monitorStatusAsString()	The status of a monitor.
List<MonitorRemoteResource>	remoteResources()	The remote resources for this monitor.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetMonitorResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags for a monitor.
GetMonitorResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

monitorArn

public final String monitorArn()

The Amazon Resource Name (ARN) of the monitor.

Returns:

The Amazon Resource Name (ARN) of the monitor.

monitorName

public final String monitorName()

The name of the monitor.

Returns:

The name of the monitor.

monitorStatus

public final MonitorStatus monitorStatus()

The status of a monitor. The status can be one of the following

• PENDING: The monitor is in the process of being created.

• ACTIVE: The monitor is active.

• INACTIVE: The monitor is inactive.

• ERROR: Monitor creation failed due to an error.

• DELETING: The monitor is in the process of being deleted.

If the service returns an enum value that is not available in the current SDK version, monitorStatus will return MonitorStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitorStatusAsString().

Returns:

The status of a monitor. The status can be one of the following

• PENDING: The monitor is in the process of being created.

• ACTIVE: The monitor is active.

• INACTIVE: The monitor is inactive.

• ERROR: Monitor creation failed due to an error.

• DELETING: The monitor is in the process of being deleted.

See Also:

MonitorStatus

monitorStatusAsString

public final String monitorStatusAsString()

The status of a monitor. The status can be one of the following

• PENDING: The monitor is in the process of being created.

• ACTIVE: The monitor is active.

• INACTIVE: The monitor is inactive.

• ERROR: Monitor creation failed due to an error.

• DELETING: The monitor is in the process of being deleted.

If the service returns an enum value that is not available in the current SDK version, monitorStatus will return MonitorStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitorStatusAsString().

Returns:

The status of a monitor. The status can be one of the following

• PENDING: The monitor is in the process of being created.

• ACTIVE: The monitor is active.

• INACTIVE: The monitor is inactive.

• ERROR: Monitor creation failed due to an error.

• DELETING: The monitor is in the process of being deleted.

See Also:

MonitorStatus

hasLocalResources

public final boolean hasLocalResources()

For responses, this returns true if the service returned a value for the LocalResources 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.

localResources

public final List<MonitorLocalResource> localResources()

The local resources for this monitor.

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 hasLocalResources() method.

Returns:

The local resources for this monitor.

hasRemoteResources

public final boolean hasRemoteResources()

For responses, this returns true if the service returned a value for the RemoteResources 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.

remoteResources

public final List<MonitorRemoteResource> remoteResources()

The remote resources for this monitor.

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 hasRemoteResources() method.

Returns:

The remote resources for this monitor.

createdAt

public final Instant createdAt()

The date and time when the monitor was created.

Returns:

The date and time when the monitor was created.

modifiedAt

public final Instant modifiedAt()

The date and time when the monitor was last modified.

Returns:

The date and time when the monitor was last modified.

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 tags for a monitor.

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 for a monitor.

toBuilder

public GetMonitorResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetMonitorResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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