Class GetMonitorResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.internetmonitor.model.InternetMonitorResponse
software.amazon.awssdk.services.internetmonitor.model.GetMonitorResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMonitorResponse extends InternetMonitorResponse implements ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>

  • Method Details

    • monitorName

      public final String monitorName()

      The name of the monitor.

      Returns:
      The name of the monitor.

    • monitorArn

      public final String monitorArn()

      The Amazon Resource Name (ARN) of the monitor.

      Returns:
      The Amazon Resource Name (ARN) of the monitor.

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources 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.

    • resources

      public final List<String> resources()

      The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

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

      Returns:
      The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

    • status

      public final MonitorConfigState status()

      The status of the monitor.

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

      Returns:
      The status of the monitor.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the monitor.

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

      Returns:
      The status of the monitor.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time when the monitor was created.

      Returns:
      The time when the monitor was created.

    • modifiedAt

      public final Instant modifiedAt()

      The last time that the monitor was modified.

      Returns:
      The last time that the monitor was modified.

    • processingStatus

      public final MonitorProcessingStatusCode processingStatus()

      The health of the data processing for the monitor.

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

      Returns:
      The health of the data processing for the monitor.
      See Also:

    • processingStatusAsString

      public final String processingStatusAsString()

      The health of the data processing for the monitor.

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

      Returns:
      The health of the data processing for the monitor.
      See Also:

    • processingStatusInfo

      public final String processingStatusInfo()

      Additional information about the health of the data processing for the monitor.

      Returns:
      Additional information about the health of the data processing for the monitor.

    • 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 that have been added to 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 that have been added to monitor.

    • maxCityNetworksToMonitor

      public final Integer maxCityNetworksToMonitor()

      The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.

      To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

      Returns:
      The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.

      To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

    • internetMeasurementsLogDelivery

      public final InternetMeasurementsLogDelivery internetMeasurementsLogDelivery()

      Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

      Returns:
      Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

    • trafficPercentageToMonitor

      public final Integer trafficPercentageToMonitor()

      The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

      To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

      Returns:
      The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

      To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

    • healthEventsConfig

      public final HealthEventsConfig healthEventsConfig()

      The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

      For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

      Returns:
      The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

      For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

    • toBuilder

      public GetMonitorResponse.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<GetMonitorResponse.Builder,GetMonitorResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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.