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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetMonitorResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetMonitorResponse.Builderbuilder()InstantcreatedAt()The time when the monitor was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasResources()For responses, this returns true if the service returned a value for the Resources property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.HealthEventsConfighealthEventsConfig()The list of health event threshold configurations.InternetMeasurementsLogDeliveryinternetMeasurementsLogDelivery()Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.IntegermaxCityNetworksToMonitor()The maximum number of city-networks to monitor for your resources.InstantmodifiedAt()The last time that the monitor was modified.StringmonitorArn()The Amazon Resource Name (ARN) of the monitor.StringmonitorName()The name of the monitor.MonitorProcessingStatusCodeprocessingStatus()The health of the data processing for the monitor.StringprocessingStatusAsString()The health of the data processing for the monitor.StringprocessingStatusInfo()Additional information about the health of the data processing for the monitor.List<String>resources()The resources monitored by the monitor.List<SdkField<?>>sdkFields()static Class<? extends GetMonitorResponse.Builder>serializableBuilderClass()MonitorConfigStatestatus()The status of the monitor.StringstatusAsString()The status of the monitor.Map<String,String>tags()The tags that have been added to monitor.GetMonitorResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.IntegertrafficPercentageToMonitor()The percentage of the internet-facing traffic for your application to monitor with this monitor.-
Methods inherited from class software.amazon.awssdk.services.internetmonitor.model.InternetMonitorResponse
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
-
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 theisEmpty()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,
statuswill returnMonitorConfigState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the monitor.
- See Also:
MonitorConfigState
-
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,
statuswill returnMonitorConfigState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the monitor.
- See Also:
MonitorConfigState
-
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,
processingStatuswill returnMonitorProcessingStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprocessingStatusAsString().- Returns:
- The health of the data processing for the monitor.
- See Also:
MonitorProcessingStatusCode
-
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,
processingStatuswill returnMonitorProcessingStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprocessingStatusAsString().- Returns:
- The health of the data processing for the monitor.
- See Also:
MonitorProcessingStatusCode
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetMonitorResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetMonitorResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-