Class RepositoryAssociation

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

Information about a repository association. The DescribeRepositoryAssociation operation returns a RepositoryAssociation object.

See Also:

  • Method Details

    • associationId

      public final String associationId()

      The ID of the repository association.

      Returns:
      The ID of the repository association.

    • associationArn

      public final String associationArn()

      The Amazon Resource Name (ARN) identifying the repository association.

      Returns:
      The Amazon Resource Name (ARN) identifying the repository association.

    • connectionArn

      public final String connectionArn()

      The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the Amazon Web Services CodeStar Connections API Reference.

      Returns:
      The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the Amazon Web Services CodeStar Connections API Reference.

    • name

      public final String name()

      The name of the repository.

      Returns:
      The name of the repository.

    • owner

      public final String owner()

      The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

      Returns:
      The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

    • providerType

      public final ProviderType providerType()

      The provider type of the repository association.

      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 provider type of the repository association.
      See Also:

    • providerTypeAsString

      public final String providerTypeAsString()

      The provider type of the repository association.

      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 provider type of the repository association.
      See Also:

    • state

      public final RepositoryAssociationState state()

      The state of the repository association.

      The valid repository association states are:

      • Associated: The repository association is complete.

      • Associating: CodeGuru Reviewer is:

        • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

          If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

        • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

      • Failed: The repository failed to associate or disassociate.

      • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

      • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

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

      Returns:
      The state of the repository association.

      The valid repository association states are:

      • Associated: The repository association is complete.

      • Associating: CodeGuru Reviewer is:

        • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

          If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

        • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

      • Failed: The repository failed to associate or disassociate.

      • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

      • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the repository association.

      The valid repository association states are:

      • Associated: The repository association is complete.

      • Associating: CodeGuru Reviewer is:

        • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

          If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

        • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

      • Failed: The repository failed to associate or disassociate.

      • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

      • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

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

      Returns:
      The state of the repository association.

      The valid repository association states are:

      • Associated: The repository association is complete.

      • Associating: CodeGuru Reviewer is:

        • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

          If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

        • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

      • Failed: The repository failed to associate or disassociate.

      • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

      • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

      See Also:

    • stateReason

      public final String stateReason()

      A description of why the repository association is in the current state.

      Returns:
      A description of why the repository association is in the current state.

    • lastUpdatedTimeStamp

      public final Instant lastUpdatedTimeStamp()

      The time, in milliseconds since the epoch, when the repository association was last updated.

      Returns:
      The time, in milliseconds since the epoch, when the repository association was last updated.

    • createdTimeStamp

      public final Instant createdTimeStamp()

      The time, in milliseconds since the epoch, when the repository association was created.

      Returns:
      The time, in milliseconds since the epoch, when the repository association was created.

    • kmsKeyDetails

      public final KMSKeyDetails kmsKeyDetails()

      A KMSKeyDetails object that contains:

      • The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK).

      • The ID of the Amazon Web Services KMS key that is associated with this repository association.

      Returns:
      A KMSKeyDetails object that contains:

      • The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed ( CUSTOMER_MANAGED_CMK).

      • The ID of the Amazon Web Services KMS key that is associated with this repository association.

    • s3RepositoryDetails

      public final S3RepositoryDetails s3RepositoryDetails()
      Returns the value of the S3RepositoryDetails property for this object.
      Returns:
      The value of the S3RepositoryDetails property for this object.

    • toBuilder

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

    • builder

      public static RepositoryAssociation.Builder builder()

    • serializableBuilderClass

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