Class GetEnvironmentResponse

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

  • Method Details

    • actualCapacity

      public final Integer actualCapacity()

      The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

      Returns:
      The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

    • creationTime

      public final Instant creationTime()

      The timestamp when the runtime environment was created.

      Returns:
      The timestamp when the runtime environment was created.

    • description

      public final String description()

      The description of the runtime environment.

      Returns:
      The description of the runtime environment.

    • engineType

      public final EngineType engineType()

      The target platform for the runtime environment.

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

      Returns:
      The target platform for the runtime environment.
      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      The target platform for the runtime environment.

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

      Returns:
      The target platform for the runtime environment.
      See Also:

    • engineVersion

      public final String engineVersion()

      The version of the runtime engine.

      Returns:
      The version of the runtime engine.

    • environmentArn

      public final String environmentArn()

      The Amazon Resource Name (ARN) of the runtime environment.

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

    • environmentId

      public final String environmentId()

      The unique identifier of the runtime environment.

      Returns:
      The unique identifier of the runtime environment.

    • highAvailabilityConfig

      public final HighAvailabilityConfig highAvailabilityConfig()

      The desired capacity of the high availability configuration for the runtime environment.

      Returns:
      The desired capacity of the high availability configuration for the runtime environment.

    • instanceType

      public final String instanceType()

      The type of instance underlying the runtime environment.

      Returns:
      The type of instance underlying the runtime environment.

    • kmsKeyId

      public final String kmsKeyId()

      The identifier of a customer managed key.

      Returns:
      The identifier of a customer managed key.

    • loadBalancerArn

      public final String loadBalancerArn()

      The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

      Returns:
      The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

    • name

      public final String name()

      The name of the runtime environment. Must be unique within the account.

      Returns:
      The name of the runtime environment. Must be unique within the account.

    • networkType

      public final NetworkType networkType()

      The network type supported by the runtime environment.

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

      Returns:
      The network type supported by the runtime environment.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      The network type supported by the runtime environment.

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

      Returns:
      The network type supported by the runtime environment.
      See Also:

    • pendingMaintenance

      public final PendingMaintenance pendingMaintenance()

      Indicates the pending maintenance scheduled on this environment.

      Returns:
      Indicates the pending maintenance scheduled on this environment.

    • preferredMaintenanceWindow

      public final String preferredMaintenanceWindow()

      The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

      Returns:
      The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Whether applications running in this runtime environment are publicly accessible.

      Returns:
      Whether applications running in this runtime environment are publicly accessible.

    • hasSecurityGroupIds

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

    • securityGroupIds

      public final List<String> securityGroupIds()

      The unique identifiers of the security groups assigned to this runtime environment.

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

      Returns:
      The unique identifiers of the security groups assigned to this runtime environment.

    • status

      public final EnvironmentLifecycle status()

      The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.

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

      Returns:
      The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.

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

      Returns:
      The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.
      See Also:

    • statusReason

      public final String statusReason()

      The reason for the reported status.

      Returns:
      The reason for the reported status.

    • hasStorageConfigurations

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

    • storageConfigurations

      public final List<StorageConfiguration> storageConfigurations()

      The storage configurations defined for the runtime environment.

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

      Returns:
      The storage configurations defined for the runtime environment.

    • hasSubnetIds

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

    • subnetIds

      public final List<String> subnetIds()

      The unique identifiers of the subnets assigned to this runtime environment.

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

      Returns:
      The unique identifiers of the subnets assigned to this runtime environment.

    • 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 defined for this runtime environment.

      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 defined for this runtime environment.

    • vpcId

      public final String vpcId()

      The unique identifier for the VPC used with this runtime environment.

      Returns:
      The unique identifier for the VPC used with this runtime environment.

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.