Class Environment

java.lang.Object
software.amazon.awssdk.services.interconnect.model.Environment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Environment.Builder,Environment>
@Generated("software.amazon.awssdk:codegen") public final class Environment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Environment.Builder,Environment>

Defines the logical topology that an AWS Interconnect Connection is created upon.

Specifically, an Environment defines the partner The remote Cloud Service Provider of this resource. or The remote Last Mile Provider of this resource. and the region or location specification to which an AWS Interconnect Connection can be made.

See Also:

  • Method Details

    • provider

      public final Provider provider()

      The provider on the remote side of this Connection.

      Returns:
      The provider on the remote side of this Connection.

    • location

      public final String location()

      The provider specific location on the remote side of this Connection.

      Returns:
      The provider specific location on the remote side of this Connection.

    • environmentId

      public final String environmentId()

      The identifier of this Environment

      Returns:
      The identifier of this Environment

    • state

      public final EnvironmentState state()

      The state of the Environment. Possible values:

      • available: The environment is available and new Connection objects can be requested.

      • limited: The environment is available, but overall capacity is limited. The set of available bandwidths

      • unavailable: The environment is currently unavailable.

      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 state of the Environment. Possible values:

      • available: The environment is available and new Connection objects can be requested.

      • limited: The environment is available, but overall capacity is limited. The set of available bandwidths

      • unavailable: The environment is currently unavailable.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the Environment. Possible values:

      • available: The environment is available and new Connection objects can be requested.

      • limited: The environment is available, but overall capacity is limited. The set of available bandwidths

      • unavailable: The environment is currently unavailable.

      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 state of the Environment. Possible values:

      • available: The environment is available and new Connection objects can be requested.

      • limited: The environment is available, but overall capacity is limited. The set of available bandwidths

      • unavailable: The environment is currently unavailable.

      See Also:

    • bandwidths

      public final Bandwidths bandwidths()

      The sets of bandwidths that are available and supported on this environment.

      Returns:
      The sets of bandwidths that are available and supported on this environment.

    • type

      public final String type()

      The specific product type of Connection objects provided by this Environment.

      Returns:
      The specific product type of Connection objects provided by this Environment.

    • activationPageUrl

      public final String activationPageUrl()

      An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

      Returns:
      An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

    • remoteIdentifierType

      public final RemoteAccountIdentifierType remoteIdentifierType()

      The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

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

      Returns:
      The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.
      See Also:

    • remoteIdentifierTypeAsString

      public final String remoteIdentifierTypeAsString()

      The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

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

      Returns:
      The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.
      See Also:

    • toBuilder

      public Environment.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<Environment.Builder,Environment>
      Returns:
      a builder for type T

    • builder

      public static Environment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Environment.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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