Class ListCodeReviewsRequest

    • Method Detail

      • providerTypes

        public final List<ProviderType> providerTypes()

        List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

        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 for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.
      • 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 for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

        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 for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.
      • states

        public final List<JobState> states()

        List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending 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.

        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 states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending 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.

      • 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 states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending 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.

        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 states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending 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.

      • hasRepositoryNames

        public final boolean hasRepositoryNames()
        For responses, this returns true if the service returned a value for the RepositoryNames 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.
      • repositoryNames

        public final List<String> repositoryNames()

        List of repository names for filtering that needs to be applied before displaying the result.

        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 hasRepositoryNames() method.

        Returns:
        List of repository names for filtering that needs to be applied before displaying the result.
      • type

        public final Type type()

        The type of code reviews to list in the response.

        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 code reviews to list in the response.
        See Also:
        Type
      • typeAsString

        public final String typeAsString()

        The type of code reviews to list in the response.

        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 code reviews to list in the response.
        See Also:
        Type
      • maxResults

        public final Integer maxResults()

        The maximum number of results that are returned per call. The default is 100.

        Returns:
        The maximum number of results that are returned per call. The default is 100.
      • nextToken

        public final String nextToken()

        If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

        Returns:
        If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
      • 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