software.amazon.awssdk.services.codegurureviewer.model

Class CodeReviewSummary

java.lang.Object

software.amazon.awssdk.services.codegurureviewer.model.CodeReviewSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CodeReviewSummary.Builder,CodeReviewSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class CodeReviewSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CodeReviewSummary.Builder,CodeReviewSummary>

Information about the summary of the code review.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CodeReviewSummary.Builder

Method Summary

Modifier and Type	Method and Description
static CodeReviewSummary.Builder	builder()
String	codeReviewArn() The Amazon Resource Name (ARN) of the CodeReview object.
Instant	createdTimeStamp() The time, in milliseconds since the epoch, when the code review was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTimeStamp() The time, in milliseconds since the epoch, when the code review was last updated.
MetricsSummary	metricsSummary() The statistics from the code review.
String	name() The name of the code review.
String	owner() The owner of the repository.
ProviderType	providerType() The provider type of the repository association.
String	providerTypeAsString() The provider type of the repository association.
String	pullRequestId() The pull request ID for the code review.
String	repositoryName() The name of the repository.
List<SdkField<?>>	sdkFields()
static Class<? extends CodeReviewSummary.Builder>	serializableBuilderClass()
SourceCodeType	sourceCodeType() Returns the value of the SourceCodeType property for this object.
JobState	state() The state of the code review.
String	stateAsString() The state of the code review.
CodeReviewSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Type	type() The type of the code review.
String	typeAsString() The type of the code review.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the code review.

Returns:

The name of the code review.

codeReviewArn

public final String codeReviewArn()

The Amazon Resource Name (ARN) of the CodeReview object.

Returns:

The Amazon Resource Name (ARN) of the CodeReview object.

repositoryName

public final String repositoryName()

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:

ProviderType

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:

ProviderType

state

public final JobState state()

The state of the code review.

The valid code review states are:

• Completed: The code review is complete.

• Pending: The code review started and has not completed or failed.

• Failed: The code review failed.

• Deleting: The code review is being deleted.

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

Returns:

The state of the code review.

The valid code review states are:

• Completed: The code review is complete.

• Pending: The code review started and has not completed or failed.

• Failed: The code review failed.

• Deleting: The code review is being deleted.

See Also:

JobState

stateAsString

public final String stateAsString()

The state of the code review.

The valid code review states are:

• Completed: The code review is complete.

• Pending: The code review started and has not completed or failed.

• Failed: The code review failed.

• Deleting: The code review is being deleted.

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

Returns:

The state of the code review.

The valid code review states are:

• Completed: The code review is complete.

• Pending: The code review started and has not completed or failed.

• Failed: The code review failed.

• Deleting: The code review is being deleted.

See Also:

JobState

createdTimeStamp

public final Instant createdTimeStamp()

The time, in milliseconds since the epoch, when the code review was created.

Returns:

The time, in milliseconds since the epoch, when the code review was created.

lastUpdatedTimeStamp

public final Instant lastUpdatedTimeStamp()

The time, in milliseconds since the epoch, when the code review was last updated.

Returns:

The time, in milliseconds since the epoch, when the code review was last updated.

type

public final Type type()

The type of the code review.

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

Returns:

The type of the code review.

See Also:

Type

typeAsString

public final String typeAsString()

The type of the code review.

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

Returns:

The type of the code review.

See Also:

Type

pullRequestId

public final String pullRequestId()

The pull request ID for the code review.

Returns:

The pull request ID for the code review.

metricsSummary

public final MetricsSummary metricsSummary()

The statistics from the code review.

Returns:

The statistics from the code review.

sourceCodeType

public final SourceCodeType sourceCodeType()

Returns the value of the SourceCodeType property for this object.

Returns:

The value of the SourceCodeType property for this object.

toBuilder

public CodeReviewSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CodeReviewSummary.Builder,CodeReviewSummary>

builder

public static CodeReviewSummary.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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