Class CreateMonitorRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorRequest
-
- software.amazon.awssdk.services.networkflowmonitor.model.CreateMonitorRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMonitorRequest extends NetworkFlowMonitorRequest implements ToCopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateMonitorRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateMonitorRequest.Builderbuilder()StringclientToken()A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLocalResources()For responses, this returns true if the service returned a value for the LocalResources property.booleanhasRemoteResources()For responses, this returns true if the service returned a value for the RemoteResources property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<MonitorLocalResource>localResources()The local resources to monitor.StringmonitorName()The name of the monitor.List<MonitorRemoteResource>remoteResources()The remote resources to monitor.StringscopeArn()The Amazon Resource Name (ARN) of the scope for the monitor.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateMonitorRequest.Builder>serializableBuilderClass()Map<String,String>tags()The tags for a monitor.CreateMonitorRequest.BuildertoBuilder()StringtoString()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.
- Returns:
- The name of the monitor.
-
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 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.
-
localResources
public final List<MonitorLocalResource> localResources()
The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local 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
hasLocalResources()method.- Returns:
- The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local resource.
-
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 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.
-
remoteResources
public final List<MonitorRemoteResource> remoteResources()
The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) 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 in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.
-
scopeArn
public final String scopeArn()
The Amazon Resource Name (ARN) of the scope for the monitor.
- Returns:
- The Amazon Resource Name (ARN) of the scope for the monitor.
-
clientToken
public final String clientToken()
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
- Returns:
- A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
-
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 for a monitor. You can add a maximum of 200 tags.
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. You can add a maximum of 200 tags.
-
toBuilder
public CreateMonitorRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>- Specified by:
toBuilderin classNetworkFlowMonitorRequest
-
builder
public static CreateMonitorRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateMonitorRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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 classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-