Returns the pullRequestComments Resource.
close(name, body=None, x__xgafv=None)
Closes a pull request without merging.
create(parent, body=None, x__xgafv=None)
Creates a pull request.
Gets a pull request.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists pull requests in a repository.
listFileDiffs(name, pageSize=None, pageToken=None, x__xgafv=None)
Lists a pull request's file diffs.
Retrieves the next page of results.
Retrieves the next page of results.
merge(name, body=None, x__xgafv=None)
Merges a pull request.
open(name, body=None, x__xgafv=None)
Opens a pull request.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a pull request.
close(name, body=None, x__xgafv=None)
Closes a pull request without merging.
Args:
name: string, Required. The pull request to close. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
body: object, The request body.
The object takes the form of:
{ # ClosePullRequestRequest is the request to close a pull request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
create(parent, body=None, x__xgafv=None)
Creates a pull request.
Args:
parent: string, Required. The repository that the pull request is created from. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
"base": { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"body": "A String", # Optional. The pull request body. Provides a detailed description of the changes.
"closeTime": "A String", # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
"createTime": "A String", # Output only. Creation timestamp.
"head": { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"name": "A String", # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
"state": "A String", # Output only. State of the pull request (open, closed or merged).
"title": "A String", # Required. The pull request title.
"updateTime": "A String", # Output only. Last updated timestamp.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets a pull request.
Args:
name: string, Required. Name of the pull request to retrieve. The format is `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
"base": { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"body": "A String", # Optional. The pull request body. Provides a detailed description of the changes.
"closeTime": "A String", # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
"createTime": "A String", # Output only. Creation timestamp.
"head": { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"name": "A String", # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
"state": "A String", # Output only. State of the pull request (open, closed or merged).
"title": "A String", # Required. The pull request title.
"updateTime": "A String", # Output only. Last updated timestamp.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists pull requests in a repository.
Args:
parent: string, Required. The repository in which to list pull requests. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}` (required)
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListPullRequestsResponse is the response to list pull requests.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"pullRequests": [ # The list of pull requests.
{ # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
"base": { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"body": "A String", # Optional. The pull request body. Provides a detailed description of the changes.
"closeTime": "A String", # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
"createTime": "A String", # Output only. Creation timestamp.
"head": { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"name": "A String", # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
"state": "A String", # Output only. State of the pull request (open, closed or merged).
"title": "A String", # Required. The pull request title.
"updateTime": "A String", # Output only. Last updated timestamp.
},
],
}
listFileDiffs(name, pageSize=None, pageToken=None, x__xgafv=None)
Lists a pull request's file diffs.
Args:
name: string, Required. The pull request to list file diffs for. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListPullRequestFileDiffsResponse is the response containing file diffs returned from ListPullRequestFileDiffs.
"fileDiffs": [ # The list of pull request file diffs.
{ # Metadata of a FileDiff. FileDiff represents a single file diff in a pull request.
"action": "A String", # Output only. The action taken on the file (eg. added, modified, deleted).
"name": "A String", # Output only. The name of the file.
"patch": "A String", # Output only. The git patch containing the file changes.
"sha": "A String", # Output only. The commit pointing to the file changes.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
}
listFileDiffs_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
merge(name, body=None, x__xgafv=None)
Merges a pull request.
Args:
name: string, Required. The pull request to merge. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
body: object, The request body.
The object takes the form of:
{ # MergePullRequestRequest is the request to merge a pull request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
open(name, body=None, x__xgafv=None)
Opens a pull request.
Args:
name: string, Required. The pull request to open. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
body: object, The request body.
The object takes the form of:
{ # OpenPullRequestRequest is the request to open a pull request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a pull request.
Args:
name: string, Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
"base": { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"body": "A String", # Optional. The pull request body. Provides a detailed description of the changes.
"closeTime": "A String", # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
"createTime": "A String", # Output only. Creation timestamp.
"head": { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
"ref": "A String", # Required. Name of the branch.
"sha": "A String", # Output only. The commit at the tip of the branch.
},
"name": "A String", # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
"state": "A String", # Output only. State of the pull request (open, closed or merged).
"title": "A String", # Required. The pull request title.
"updateTime": "A String", # Output only. Last updated timestamp.
}
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the pull request resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The special value "*" means full replacement.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}