Interface Environment.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Environment.Builder,Environment>, SdkBuilder<Environment.Builder,Environment>, SdkPojo
Enclosing class:
Environment
@Mutable @NotThreadSafe public static interface Environment.Builder extends SdkPojo, CopyableBuilder<Environment.Builder,Environment>

  • Method Details

    • provider

      Environment.Builder provider(Provider provider)

      The provider on the remote side of this Connection.

      Parameters:
      provider - The provider on the remote side of this Connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • provider

      default Environment.Builder provider(Consumer<Provider.Builder> provider)

      The provider on the remote side of this Connection.

      This is a convenience method that creates an instance of the Provider.Builder avoiding the need to create one manually via Provider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provider(Provider).

      Parameters:
      provider - a consumer that will call methods on Provider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • location

      Environment.Builder location(String location)

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

      Parameters:
      location - The provider specific location on the remote side of this Connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentId

      Environment.Builder environmentId(String environmentId)

      The identifier of this Environment

      Parameters:
      environmentId - The identifier of this Environment
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Environment.Builder state(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Environment.Builder state(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bandwidths

      Environment.Builder bandwidths(Bandwidths bandwidths)

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

      Parameters:
      bandwidths - The sets of bandwidths that are available and supported on this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bandwidths

      default Environment.Builder bandwidths(Consumer<Bandwidths.Builder> bandwidths)

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

      This is a convenience method that creates an instance of the Bandwidths.Builder avoiding the need to create one manually via Bandwidths.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bandwidths(Bandwidths).

      Parameters:
      bandwidths - a consumer that will call methods on Bandwidths.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      Environment.Builder type(String type)

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

      Parameters:
      type - The specific product type of Connection objects provided by this Environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activationPageUrl

      Environment.Builder activationPageUrl(String activationPageUrl)

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

      Parameters:
      activationPageUrl - An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remoteIdentifierType

      Environment.Builder remoteIdentifierType(String remoteIdentifierType)

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

      Parameters:
      remoteIdentifierType - The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • remoteIdentifierType

      Environment.Builder remoteIdentifierType(RemoteAccountIdentifierType remoteIdentifierType)

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

      Parameters:
      remoteIdentifierType - The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: