Class Connection

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

A resource that is used to connect third-party source providers with services like CodePipeline.

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.

See Also:

  • Method Details

    • connectionName

      public final String connectionName()

      The name of the connection. Connection names must be unique in an Amazon Web Services account.

      Returns:
      The name of the connection. Connection names must be unique in an Amazon Web Services account.

    • connectionArn

      public final String connectionArn()

      The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between Amazon Web Services.

      The ARN is never reused if the connection is deleted.

      Returns:
      The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between Amazon Web Services.

      The ARN is never reused if the connection is deleted.

    • providerType

      public final ProviderType providerType()

      The name of the external provider where your third-party code repository is configured.

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

      Returns:
      The name of the external provider where your third-party code repository is configured.
      See Also:

    • providerTypeAsString

      public final String providerTypeAsString()

      The name of the external provider where your third-party code repository is configured.

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

      Returns:
      The name of the external provider where your third-party code repository is configured.
      See Also:

    • ownerAccountId

      public final String ownerAccountId()

      The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

      Returns:
      The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

    • connectionStatus

      public final ConnectionStatus connectionStatus()

      The current status of the connection.

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

      Returns:
      The current status of the connection.
      See Also:

    • connectionStatusAsString

      public final String connectionStatusAsString()

      The current status of the connection.

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

      Returns:
      The current status of the connection.
      See Also:

    • hostArn

      public final String hostArn()

      The Amazon Resource Name (ARN) of the host associated with the connection.

      Returns:
      The Amazon Resource Name (ARN) of the host associated with the connection.

    • toBuilder

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

    • builder

      public static Connection.Builder builder()

    • serializableBuilderClass

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