Class RequestMetadata

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

Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.

See Also:

  • Method Details

    • requestId

      public final String requestId()

      The ID of the request. This is required for a pull request code review.

      Returns:
      The ID of the request. This is required for a pull request code review.

    • requester

      public final String requester()

      An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

      Returns:
      An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

    • eventInfo

      public final EventInfo eventInfo()

      Information about the event associated with a code review.

      Returns:
      Information about the event associated with a code review.

    • vendorName

      public final VendorName vendorName()

      The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation .

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

      Returns:
      The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.
      See Also:

    • vendorNameAsString

      public final String vendorNameAsString()

      The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation .

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

      Returns:
      The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.
      See Also:

    • toBuilder

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

    • builder

      public static RequestMetadata.Builder builder()

    • serializableBuilderClass

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