software.amazon.awssdk.services.codegurureviewer.model

Class ListRepositoryAssociationsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codegurureviewer.model.CodeGuruReviewerRequest

software.amazon.awssdk.services.codegurureviewer.model.ListRepositoryAssociationsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRepositoryAssociationsRequest.Builder,ListRepositoryAssociationsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListRepositoryAssociationsRequest
extends CodeGuruReviewerRequest
implements ToCopyableBuilder<ListRepositoryAssociationsRequest.Builder,ListRepositoryAssociationsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListRepositoryAssociationsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListRepositoryAssociationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNames() For responses, this returns true if the service returned a value for the Names property.
boolean	hasOwners() For responses, this returns true if the service returned a value for the Owners property.
boolean	hasProviderTypes() For responses, this returns true if the service returned a value for the ProviderTypes property.
boolean	hasStates() For responses, this returns true if the service returned a value for the States property.
Integer	maxResults() The maximum number of repository association results returned by ListRepositoryAssociations in paginated output.
List<String>	names() List of repository names to use as a filter.
String	nextToken() The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter.
List<String>	owners() List of owners to use as a filter.
List<ProviderType>	providerTypes() List of provider types to use as a filter.
List<String>	providerTypesAsStrings() List of provider types to use as a filter.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRepositoryAssociationsRequest.Builder>	serializableBuilderClass()
List<RepositoryAssociationState>	states() List of repository association states to use as a filter.
List<String>	statesAsStrings() List of repository association states to use as a filter.
ListRepositoryAssociationsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

providerTypes

public final List<ProviderType> providerTypes()

List of provider types to use as a filter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProviderTypes() method.

Returns:

List of provider types to use as a filter.

hasProviderTypes

public final boolean hasProviderTypes()

For responses, this returns true if the service returned a value for the ProviderTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

providerTypesAsStrings

public final List<String> providerTypesAsStrings()

List of provider types to use as a filter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProviderTypes() method.

Returns:

List of provider types to use as a filter.

states

public final List<RepositoryAssociationState> states()

List of repository association states to use as a filter.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStates() method.

Returns:

List of repository association states to use as a filter.

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.

hasStates

public final boolean hasStates()

For responses, this returns true if the service returned a value for the States property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statesAsStrings

public final List<String> statesAsStrings()

List of repository association states to use as a filter.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStates() method.

Returns:

List of repository association states to use as a filter.

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.

hasNames

public final boolean hasNames()

For responses, this returns true if the service returned a value for the Names property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

names

public final List<String> names()

List of repository names to use as a filter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNames() method.

Returns:

List of repository names to use as a filter.

hasOwners

public final boolean hasOwners()

For responses, this returns true if the service returned a value for the Owners property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

owners

public final List<String> owners()

List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOwners() method.

Returns:

List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository.

maxResults

public final Integer maxResults()

The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

Returns:

The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

nextToken

public final String nextToken()

The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

toBuilder

public ListRepositoryAssociationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRepositoryAssociationsRequest.Builder,ListRepositoryAssociationsRequest>

Specified by:

toBuilder in class CodeGuruReviewerRequest

builder

public static ListRepositoryAssociationsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListRepositoryAssociationsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo