Package software.amazon.awssdk.services.directconnect.model

Class DirectConnectGatewayAssociationProposal

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

Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

See Also:

  • Method Details

    • proposalId

      public final String proposalId()

      The ID of the association proposal.

      Returns:
      The ID of the association proposal.

    • directConnectGatewayId

      public final String directConnectGatewayId()

      The ID of the Direct Connect gateway.

      Returns:
      The ID of the Direct Connect gateway.

    • directConnectGatewayOwnerAccount

      public final String directConnectGatewayOwnerAccount()

      The ID of the Amazon Web Services account that owns the Direct Connect gateway.

      Returns:
      The ID of the Amazon Web Services account that owns the Direct Connect gateway.

    • proposalState

      public final DirectConnectGatewayAssociationProposalState proposalState()

      The state of the proposal. The following are possible values:

      • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

      • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

      • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

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

      Returns:
      The state of the proposal. The following are possible values:

      • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

      • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

      • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

      See Also:

    • proposalStateAsString

      public final String proposalStateAsString()

      The state of the proposal. The following are possible values:

      • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

      • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

      • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

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

      Returns:
      The state of the proposal. The following are possible values:

      • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

      • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

      • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

      See Also:

    • associatedGateway

      public final AssociatedGateway associatedGateway()

      Information about the associated gateway.

      Returns:
      Information about the associated gateway.

    • hasExistingAllowedPrefixesToDirectConnectGateway

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

    • existingAllowedPrefixesToDirectConnectGateway

      public final List<RouteFilterPrefix> existingAllowedPrefixesToDirectConnectGateway()

      The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

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

      Returns:
      The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

    • hasRequestedAllowedPrefixesToDirectConnectGateway

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

    • requestedAllowedPrefixesToDirectConnectGateway

      public final List<RouteFilterPrefix> requestedAllowedPrefixesToDirectConnectGateway()

      The Amazon VPC prefixes to advertise to the Direct Connect gateway.

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

      Returns:
      The Amazon VPC prefixes to advertise to the Direct Connect gateway.

    • toBuilder

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

    • builder

      public static DirectConnectGatewayAssociationProposal.Builder builder()

    • serializableBuilderClass

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