Class GetMicrovmResponse

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

  • Method Details

    • microvmId

      public final String microvmId()

      The unique identifier of the MicroVM.

      Returns:
      The unique identifier of the MicroVM.

    • state

      public final MicrovmState state()

      The current lifecycle state of the MicroVM.

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

      Returns:
      The current lifecycle state of the MicroVM.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current lifecycle state of the MicroVM.

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

      Returns:
      The current lifecycle state of the MicroVM.
      See Also:

    • endpoint

      public final String endpoint()

      The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests.

      Returns:
      The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests.

    • imageArn

      public final String imageArn()

      The ARN of the MicroVM image used to run this MicroVM.

      Returns:
      The ARN of the MicroVM image used to run this MicroVM.

    • imageVersion

      public final String imageVersion()

      The version of the MicroVM image used to run this MicroVM.

      Returns:
      The version of the MicroVM image used to run this MicroVM.

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the IAM execution role assumed by the MicroVM.

      Returns:
      The ARN of the IAM execution role assumed by the MicroVM.

    • idlePolicy

      public final IdlePolicy idlePolicy()

      The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior.

      Returns:
      The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior.

    • maximumDurationInSeconds

      public final Integer maximumDurationInSeconds()

      The maximum duration in seconds that the MicroVM can exist before being terminated by the platform.

      Returns:
      The maximum duration in seconds that the MicroVM can exist before being terminated by the platform.

    • startedAt

      public final Instant startedAt()

      The timestamp when the MicroVM first started.

      Returns:
      The timestamp when the MicroVM first started.

    • terminatedAt

      public final Instant terminatedAt()

      The timestamp when the MicroVM terminated.

      Returns:
      The timestamp when the MicroVM terminated.

    • stateReason

      public final String stateReason()

      The reason for why the MicroVM is in the current state.

      Returns:
      The reason for why the MicroVM is in the current state.

    • hasIngressNetworkConnectors

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

    • ingressNetworkConnectors

      public final List<String> ingressNetworkConnectors()

      The list of ingress network connectors configured for the MicroVM.

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

      Returns:
      The list of ingress network connectors configured for the MicroVM.

    • hasEgressNetworkConnectors

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

    • egressNetworkConnectors

      public final List<String> egressNetworkConnectors()

      The list of egress network connectors configured for the MicroVM.

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

      Returns:
      The list of egress network connectors configured for the MicroVM.

    • toBuilder

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

    • builder

      public static GetMicrovmResponse.Builder builder()

    • serializableBuilderClass

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