GetEnvironmentResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class GetEnvironmentResponse
extends M2Response
implements ToCopyableBuilder<GetEnvironmentResponse.Builder,GetEnvironmentResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetEnvironmentResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetEnvironmentResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`actualCapacity()` The number of instances included in the runtime environment.
`static GetEnvironmentResponse.Builder`	`builder()`
`Instant`	`creationTime()` The timestamp when the runtime environment was created.
`String`	`description()` The description of the runtime environment.
`EngineType`	`engineType()` The target platform for the runtime environment.
`String`	`engineTypeAsString()` The target platform for the runtime environment.
`String`	`engineVersion()` The version of the runtime engine.
`String`	`environmentArn()` The Amazon Resource Name (ARN) of the runtime environment.
`String`	`environmentId()` The unique identifier of the runtime environment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasStorageConfigurations()` For responses, this returns true if the service returned a value for the StorageConfigurations property.
`boolean`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`HighAvailabilityConfig`	`highAvailabilityConfig()` The desired capacity of the high availability configuration for the runtime environment.
`String`	`instanceType()` The type of instance underlying the runtime environment.
`String`	`kmsKeyId()` The identifier of a customer managed key.
`String`	`loadBalancerArn()` The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
`String`	`name()` The name of the runtime environment.
`PendingMaintenance`	`pendingMaintenance()` Indicates the pending maintenance scheduled on this environment.
`String`	`preferredMaintenanceWindow()` Configures the maintenance window you want for the runtime environment.
`Boolean`	`publiclyAccessible()` Whether applications running in this runtime environment are publicly accessible.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The unique identifiers of the security groups assigned to this runtime environment.
`static Class<? extends GetEnvironmentResponse.Builder>`	`serializableBuilderClass()`
`EnvironmentLifecycle`	`status()` The status of the runtime environment.
`String`	`statusAsString()` The status of the runtime environment.
`String`	`statusReason()` The reason for the reported status.
`List<StorageConfiguration>`	`storageConfigurations()` The storage configurations defined for the runtime environment.
`List<String>`	`subnetIds()` The unique identifiers of the subnets assigned to this runtime environment.
`Map<String,String>`	`tags()` The tags defined for this runtime environment.
`GetEnvironmentResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` The unique identifier for the VPC used with this runtime environment.

Methods inherited from class software.amazon.awssdk.services.m2.model.M2Response
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - actualCapacity
```
public final Integer actualCapacity()
```
    The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum 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 maxiumum 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:
    
    EngineType
  - 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:
    
    EngineType
  - 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.
  - 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()
```
    Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
    
    Returns:
    
    Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
  - 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 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.
    
    See Also:
    
    EnvironmentLifecycle
  - statusAsString
```
public final String statusAsString()
```
    The status of the runtime environment.
    
    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.
    
    See Also:
    
    EnvironmentLifecycle
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetEnvironmentResponse.Builder,GetEnvironmentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetEnvironmentResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.m2.model.M2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

actualCapacity

creationTime

description

engineType

engineTypeAsString

engineVersion

environmentArn

environmentId

highAvailabilityConfig

instanceType

kmsKeyId

loadBalancerArn

name

pendingMaintenance

preferredMaintenanceWindow

publiclyAccessible

hasSecurityGroupIds

securityGroupIds

status

statusAsString

statusReason

hasStorageConfigurations

storageConfigurations

hasSubnetIds

subnetIds

hasTags

tags

vpcId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields