Class CreateMonitorResponse

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.CreateMonitorResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateMonitorResponse.Builder,CreateMonitorResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateMonitorResponse extends NetworkFlowMonitorResponse implements ToCopyableBuilder<CreateMonitorResponse.Builder,CreateMonitorResponse>

  • Method Details

    • 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:

    • 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:

    • 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 to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.

      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 to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.

    • 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 to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

      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 to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

    • 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 last date and time that the monitor was modified.

      Returns:
      The last date and time that the monitor was 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 CreateMonitorResponse.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<CreateMonitorResponse.Builder,CreateMonitorResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateMonitorResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMonitorResponse.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.