software.amazon.awssdk.services.codegurureviewer.model

Interface CodeReview.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CodeReview.Builder,CodeReview>, SdkBuilder<CodeReview.Builder,CodeReview>, SdkPojo

Enclosing class:

CodeReview

public static interface CodeReview.Builder
extends SdkPojo, CopyableBuilder<CodeReview.Builder,CodeReview>

Method Summary

Modifier and Type	Method and Description
CodeReview.Builder	analysisTypes(AnalysisType... analysisTypes) The types of analysis performed during a repository analysis or a pull request review.
CodeReview.Builder	analysisTypes(Collection<AnalysisType> analysisTypes) The types of analysis performed during a repository analysis or a pull request review.
CodeReview.Builder	analysisTypesWithStrings(Collection<String> analysisTypes) The types of analysis performed during a repository analysis or a pull request review.
CodeReview.Builder	analysisTypesWithStrings(String... analysisTypes) The types of analysis performed during a repository analysis or a pull request review.
CodeReview.Builder	associationArn(String associationArn) The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code.
CodeReview.Builder	codeReviewArn(String codeReviewArn) The Amazon Resource Name (ARN) of the CodeReview object.
CodeReview.Builder	configFileState(ConfigFileState configFileState) The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis.
CodeReview.Builder	configFileState(String configFileState) The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis.
CodeReview.Builder	createdTimeStamp(Instant createdTimeStamp) The time, in milliseconds since the epoch, when the code review was created.
CodeReview.Builder	lastUpdatedTimeStamp(Instant lastUpdatedTimeStamp) The time, in milliseconds since the epoch, when the code review was last updated.
default CodeReview.Builder	metrics(Consumer<Metrics.Builder> metrics) The statistics from the code review.
CodeReview.Builder	metrics(Metrics metrics) The statistics from the code review.
CodeReview.Builder	name(String name) The name of the code review.
CodeReview.Builder	owner(String owner) The owner of the repository.
CodeReview.Builder	providerType(ProviderType providerType) The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
CodeReview.Builder	providerType(String providerType) The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
CodeReview.Builder	pullRequestId(String pullRequestId) The pull request ID for the code review.
CodeReview.Builder	repositoryName(String repositoryName) The name of the repository.
default CodeReview.Builder	sourceCodeType(Consumer<SourceCodeType.Builder> sourceCodeType) The type of the source code for the code review.
CodeReview.Builder	sourceCodeType(SourceCodeType sourceCodeType) The type of the source code for the code review.
CodeReview.Builder	state(JobState state) The valid code review states are:
CodeReview.Builder	state(String state) The valid code review states are:
CodeReview.Builder	stateReason(String stateReason) The reason for the state of the code review.
CodeReview.Builder	type(String type) The type of code review.
CodeReview.Builder	type(Type type) The type of code review.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CodeReview.Builder name(String name)

The name of the code review.

Parameters:

name - The name of the code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

codeReviewArn

CodeReview.Builder codeReviewArn(String codeReviewArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

repositoryName

CodeReview.Builder repositoryName(String repositoryName)

The name of the repository.

Parameters:

repositoryName - The name of the repository.

Returns:

Returns a reference to this object so that method calls can be chained together.

owner

CodeReview.Builder owner(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

providerType

CodeReview.Builder providerType(String providerType)

The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

Parameters:

providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProviderType, ProviderType

providerType

CodeReview.Builder providerType(ProviderType providerType)

The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

Parameters:

providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProviderType, ProviderType

state

CodeReview.Builder state(String state)

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.

Parameters:

state - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobState, JobState

state

CodeReview.Builder state(JobState state)

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.

Parameters:

state - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobState, JobState

stateReason

CodeReview.Builder stateReason(String stateReason)

The reason for the state of the code review.

Parameters:

stateReason - The reason for the state of the code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdTimeStamp

CodeReview.Builder createdTimeStamp(Instant createdTimeStamp)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedTimeStamp

CodeReview.Builder lastUpdatedTimeStamp(Instant lastUpdatedTimeStamp)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

type

CodeReview.Builder type(String type)

The type of code review.

Parameters:

type - The type of code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type, Type

type

CodeReview.Builder type(Type type)

The type of code review.

Parameters:

type - The type of code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type, Type

pullRequestId

CodeReview.Builder pullRequestId(String pullRequestId)

The pull request ID for the code review.

Parameters:

pullRequestId - The pull request ID for the code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceCodeType

CodeReview.Builder sourceCodeType(SourceCodeType sourceCodeType)

The type of the source code for the code review.

Parameters:

sourceCodeType - The type of the source code for the code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceCodeType

default CodeReview.Builder sourceCodeType(Consumer<SourceCodeType.Builder> sourceCodeType)

The type of the source code for the code review.

This is a convenience method that creates an instance of the SourceCodeType.Builder avoiding the need to create one manually via SourceCodeType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceCodeType(SourceCodeType).

Parameters:

sourceCodeType - a consumer that will call methods on SourceCodeType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sourceCodeType(SourceCodeType)

associationArn

CodeReview.Builder associationArn(String associationArn)

The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.

Parameters:

associationArn - The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.

Returns:

Returns a reference to this object so that method calls can be chained together.

metrics

CodeReview.Builder metrics(Metrics metrics)

The statistics from the code review.

Parameters:

metrics - The statistics from the code review.

Returns:

Returns a reference to this object so that method calls can be chained together.

metrics

default CodeReview.Builder metrics(Consumer<Metrics.Builder> metrics)

The statistics from the code review.

This is a convenience method that creates an instance of the Metrics.Builder avoiding the need to create one manually via Metrics.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metrics(Metrics).

Parameters:

metrics - a consumer that will call methods on Metrics.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

metrics(Metrics)

analysisTypesWithStrings

CodeReview.Builder analysisTypesWithStrings(Collection<String> analysisTypes)

The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Parameters:

analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Returns:

Returns a reference to this object so that method calls can be chained together.

analysisTypesWithStrings

CodeReview.Builder analysisTypesWithStrings(String... analysisTypes)

The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Parameters:

analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Returns:

Returns a reference to this object so that method calls can be chained together.

analysisTypes

CodeReview.Builder analysisTypes(Collection<AnalysisType> analysisTypes)

The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Parameters:

analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Returns:

Returns a reference to this object so that method calls can be chained together.

analysisTypes

CodeReview.Builder analysisTypes(AnalysisType... analysisTypes)

The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Parameters:

analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Returns:

Returns a reference to this object so that method calls can be chained together.

configFileState

CodeReview.Builder configFileState(String configFileState)

The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.

Parameters:

configFileState - The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigFileState, ConfigFileState

configFileState

CodeReview.Builder configFileState(ConfigFileState configFileState)

The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.

Parameters:

configFileState - The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfigFileState, ConfigFileState