Class GetEnvironmentResponse

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

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the environment.

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

    • createdTime

      public final Instant createdTime()

      A timestamp that indicates when the environment is created.

      Returns:
      A timestamp that indicates when the environment is created.

    • description

      public final String description()

      The description of the environment.

      Returns:
      The description of the environment.

    • environmentId

      public final String environmentId()

      The unique identifier of the environment.

      Returns:
      The unique identifier of the environment.

    • error

      public final ErrorResponse error()

      Any error associated with the environment resource.

      Returns:
      Any error associated with the environment resource.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      A timestamp that indicates when the environment was last updated.

      Returns:
      A timestamp that indicates when the environment was last updated.

    • name

      public final String name()

      The name of the environment.

      Returns:
      The name of the environment.

    • networkFabricType

      public final NetworkFabricType networkFabricType()

      The network fabric type of the environment.

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

      Returns:
      The network fabric type of the environment.
      See Also:

    • networkFabricTypeAsString

      public final String networkFabricTypeAsString()

      The network fabric type of the environment.

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

      Returns:
      The network fabric type of the environment.
      See Also:

    • ownerAccountId

      public final String ownerAccountId()

      The Amazon Web Services account ID of the environment owner.

      Returns:
      The Amazon Web Services account ID of the environment owner.

    • state

      public final EnvironmentState state()

      The current state of the environment.

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

      Returns:
      The current state of the environment.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the environment.

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

      Returns:
      The current state of the environment.
      See Also:

    • 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 to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

      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 to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

    • transitGatewayId

      public final String transitGatewayId()

      The ID of the Transit Gateway set up by the environment, if applicable.

      Returns:
      The ID of the Transit Gateway set up by the environment, if applicable.

    • toBuilder

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

    • builder

      public static GetEnvironmentResponse.Builder builder()

    • serializableBuilderClass

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