Class CreateProbeResponse

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

  • Method Details

    • probeId

      public final String probeId()

      The ID of the probe for which details are returned.

      Returns:
      The ID of the probe for which details are returned.

    • probeArn

      public final String probeArn()

      The ARN of the probe.

      Returns:
      The ARN of the probe.

    • sourceArn

      public final String sourceArn()

      The ARN of the probe.

      Returns:
      The ARN of the probe.

    • destination

      public final String destination()

      The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

      Returns:
      The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

    • destinationPort

      public final Integer destinationPort()

      The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

      Returns:
      The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

    • protocol

      public final Protocol protocol()

      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

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

      Returns:
      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

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

      Returns:
      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
      See Also:

    • packetSize

      public final Integer packetSize()

      The size of the packets sent between the source and destination. This must be a number between 56 and 8500.

      Returns:
      The size of the packets sent between the source and destination. This must be a number between 56 and 8500.

    • addressFamily

      public final AddressFamily addressFamily()

      Indicates whether the IP address is IPV4 or IPV6.

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

      Returns:
      Indicates whether the IP address is IPV4 or IPV6.
      See Also:

    • addressFamilyAsString

      public final String addressFamilyAsString()

      Indicates whether the IP address is IPV4 or IPV6.

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

      Returns:
      Indicates whether the IP address is IPV4 or IPV6.
      See Also:

    • vpcId

      public final String vpcId()

      The ID of the source VPC or subnet.

      Returns:
      The ID of the source VPC or subnet.

    • state

      public final ProbeState state()

      The state of the probe.

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

      Returns:
      The state of the probe.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the probe.

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

      Returns:
      The state of the probe.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time and date that the probe was created.

      Returns:
      The time and date that the probe was created.

    • modifiedAt

      public final Instant modifiedAt()

      The time and date when the probe was last modified.

      Returns:
      The time and date when the probe 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 list of key-value pairs assigned to the probe.

      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 list of key-value pairs assigned to the probe.

    • toBuilder

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

    • builder

      public static CreateProbeResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateProbeResponse.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.