Package com.google.gerrit.extensions.api.changes

Interface Changes

All Known Implementing Classes:

Changes.NotImplemented

public interface Changes

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Changes.NotImplemented	A default implementation which allows source compatibility when adding new methods to the interface.
static class	Changes.QueryRequest

Method Summary

Modifier and Type	Method	Description
ChangeApi	create(ChangeInput in)
ChangeInfo	createAsInfo(ChangeInput in)
ChangeApi	id(int id)	Deprecated. in favor of id(String, int)
ChangeApi	id(String id)	Look up a change by string ID.
ChangeApi	id(String project, int id)	Look up a change by project and numeric ID.
ChangeApi	id(String project, String branch, String id)	Look up a change by project, branch, and change ID.
Changes.QueryRequest	query()
Changes.QueryRequest	query(String query)

Method Details

id

@Deprecated(since="3.9")
ChangeApi id(int id)
      throws RestApiException

Deprecated.

in favor of id(String, int)

Look up a change by numeric ID.

Note: Change number is not guaranteed to unambiguously identify a change.

Parameters:

id - change number.

Returns:

API for accessing the change.

Throws:

RestApiException - if an error occurred.

See Also:

• id(String, int)

id

ChangeApi id(String id)
      throws RestApiException

Look up a change by string ID.

Parameters:

id - any identifier supported by the REST API, including change number, Change-Id, or project~branch~Change-Id triplet.

Returns:

API for accessing the change.

Throws:

RestApiException - if an error occurred.

See Also:

• id(String, int)

id

ChangeApi id(String project,
 String branch,
 String id)
      throws RestApiException

Look up a change by project, branch, and change ID.

Throws:

RestApiException

See Also:

• id(String, int)

id

ChangeApi id(String project,
 int id)
      throws RestApiException

Look up a change by project and numeric ID.

Note: This method eagerly reads the change. Methods that mutate the change do not necessarily re-read the change. Therefore, calling a getter method on an instance after calling a mutation method on that same instance is not guaranteed to reflect the mutation. It is not recommended to store references to ChangeApi instances. Also note that the change numeric id without a project name parameter may fail to identify a unique change element, because the potential conflict with other changes imported from Gerrit instances with a different Server-Id.

Parameters:

project - project name.

id - change number.

Throws:

RestApiException

create

@CanIgnoreReturnValue
ChangeApi create(ChangeInput in)
          throws RestApiException

Throws:

RestApiException

createAsInfo

ChangeInfo createAsInfo(ChangeInput in)
                 throws RestApiException

Throws:

RestApiException

query

Changes.QueryRequest query()

query

Changes.QueryRequest query(String query)