batchCreate(parent, body=None, x__xgafv=None)

Batch creates pull request comments.

Args:
parent: string, Required. The pull request in which to create the pull request comments. 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:

{ # The request to batch create pull request comments.
"requests": [ # Required. The request message specifying the resources to create. There should be exactly one CreatePullRequestCommentRequest with CommentDetail being REVIEW in the list, and no more than 100 CreatePullRequestCommentRequests with CommentDetail being CODE in the list
{ # The request to create a pull request comment.
"parent": "A String", # Required. The pull request in which to create the pull request comment. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}`
"pullRequestComment": { # PullRequestComment represents a comment on a pull request. # Required. The pull request comment to create.
"code": { # The comment on a code line. # Optional. The comment on a code line.
"body": "A String", # Required. The comment body.
"effectiveCommitSha": "A String", # Output only. The effective commit sha this code comment is pointing to.
"effectiveRootComment": "A String", # Output only. The root comment of the conversation, derived from the reply field.
"position": { # The position of the code comment. # Optional. The position of the comment.
"line": "A String", # Required. The line number of the comment. Positive value means it's on the new side of the diff, negative value means it's on the old side.
"path": "A String", # Required. The path of the file.
},
"reply": "A String", # Optional. Input only. The PullRequestComment resource name that this comment is replying to.
"resolved": True or False, # Output only. Boolean indicator if the comment is resolved.
},
"comment": { # The general pull request comment. # Optional. The general pull request comment.
"body": "A String", # Required. The comment body.
},
"createTime": "A String", # Output only. Creation timestamp.
"name": "A String", # Identifier. Unique identifier for the pull request comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}`
"review": { # The review summary comment. # Optional. The review summary comment.
"actionType": "A String", # Required. The review action type.
"body": "A String", # Optional. The comment body.
"effectiveCommitSha": "A String", # Output only. The effective commit sha this review is pointing to.
},
"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.
},
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a pull request comment.

Args:
  parent: string, Required. The pull request in which to create the pull request comment. 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:

{ # PullRequestComment represents a comment on a pull request.
  "code": { # The comment on a code line. # Optional. The comment on a code line.
    "body": "A String", # Required. The comment body.
    "effectiveCommitSha": "A String", # Output only. The effective commit sha this code comment is pointing to.
    "effectiveRootComment": "A String", # Output only. The root comment of the conversation, derived from the reply field.
    "position": { # The position of the code comment. # Optional. The position of the comment.
      "line": "A String", # Required. The line number of the comment. Positive value means it's on the new side of the diff, negative value means it's on the old side.
      "path": "A String", # Required. The path of the file.
    },
    "reply": "A String", # Optional. Input only. The PullRequestComment resource name that this comment is replying to.
    "resolved": True or False, # Output only. Boolean indicator if the comment is resolved.
  },
  "comment": { # The general pull request comment. # Optional. The general pull request comment.
    "body": "A String", # Required. The comment body.
  },
  "createTime": "A String", # Output only. Creation timestamp.
  "name": "A String", # Identifier. Unique identifier for the pull request comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}`
  "review": { # The review summary comment. # Optional. The review summary comment.
    "actionType": "A String", # Required. The review action type.
    "body": "A String", # Optional. The comment body.
    "effectiveCommitSha": "A String", # Output only. The effective commit sha this review is pointing to.
  },
  "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.
  },
}

delete(name, x__xgafv=None)

Deletes a pull request comment.

Args:
name: string, Required. Name of the pull request comment to delete. The format is `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}`. (required)
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 comment.

Args:
  name: string, Required. Name of the pull request comment to retrieve. The format is `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # PullRequestComment represents a comment on a pull request.
  "code": { # The comment on a code line. # Optional. The comment on a code line.
    "body": "A String", # Required. The comment body.
    "effectiveCommitSha": "A String", # Output only. The effective commit sha this code comment is pointing to.
    "effectiveRootComment": "A String", # Output only. The root comment of the conversation, derived from the reply field.
    "position": { # The position of the code comment. # Optional. The position of the comment.
      "line": "A String", # Required. The line number of the comment. Positive value means it's on the new side of the diff, negative value means it's on the old side.
      "path": "A String", # Required. The path of the file.
    },
    "reply": "A String", # Optional. Input only. The PullRequestComment resource name that this comment is replying to.
    "resolved": True or False, # Output only. Boolean indicator if the comment is resolved.
  },
  "comment": { # The general pull request comment. # Optional. The general pull request comment.
    "body": "A String", # Required. The comment body.
  },
  "createTime": "A String", # Output only. Creation timestamp.
  "name": "A String", # Identifier. Unique identifier for the pull request comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}`
  "review": { # The review summary comment. # Optional. The review summary comment.
    "actionType": "A String", # Required. The review action type.
    "body": "A String", # Optional. The comment body.
    "effectiveCommitSha": "A String", # Output only. The effective commit sha this review is pointing to.
  },
  "updateTime": "A String", # Output only. Last updated timestamp.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists pull request comments.

Args:
  parent: string, Required. The pull request in which to list pull request comments. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
  pageSize: integer, Optional. Requested page size. If unspecified, at most 100 pull request comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  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:

    { # The response to list pull request comments.
  "nextPageToken": "A String", # A token to set as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "pullRequestComments": [ # The list of pull request comments.
    { # PullRequestComment represents a comment on a pull request.
      "code": { # The comment on a code line. # Optional. The comment on a code line.
        "body": "A String", # Required. The comment body.
        "effectiveCommitSha": "A String", # Output only. The effective commit sha this code comment is pointing to.
        "effectiveRootComment": "A String", # Output only. The root comment of the conversation, derived from the reply field.
        "position": { # The position of the code comment. # Optional. The position of the comment.
          "line": "A String", # Required. The line number of the comment. Positive value means it's on the new side of the diff, negative value means it's on the old side.
          "path": "A String", # Required. The path of the file.
        },
        "reply": "A String", # Optional. Input only. The PullRequestComment resource name that this comment is replying to.
        "resolved": True or False, # Output only. Boolean indicator if the comment is resolved.
      },
      "comment": { # The general pull request comment. # Optional. The general pull request comment.
        "body": "A String", # Required. The comment body.
      },
      "createTime": "A String", # Output only. Creation timestamp.
      "name": "A String", # Identifier. Unique identifier for the pull request comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}`
      "review": { # The review summary comment. # Optional. The review summary comment.
        "actionType": "A String", # Required. The review action type.
        "body": "A String", # Optional. The comment body.
        "effectiveCommitSha": "A String", # Output only. The effective commit sha this review is pointing to.
      },
      "updateTime": "A String", # Output only. Last updated timestamp.
    },
  ],
}

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.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a pull request comment.

Args:
  name: string, Identifier. Unique identifier for the pull request comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # PullRequestComment represents a comment on a pull request.
  "code": { # The comment on a code line. # Optional. The comment on a code line.
    "body": "A String", # Required. The comment body.
    "effectiveCommitSha": "A String", # Output only. The effective commit sha this code comment is pointing to.
    "effectiveRootComment": "A String", # Output only. The root comment of the conversation, derived from the reply field.
    "position": { # The position of the code comment. # Optional. The position of the comment.
      "line": "A String", # Required. The line number of the comment. Positive value means it's on the new side of the diff, negative value means it's on the old side.
      "path": "A String", # Required. The path of the file.
    },
    "reply": "A String", # Optional. Input only. The PullRequestComment resource name that this comment is replying to.
    "resolved": True or False, # Output only. Boolean indicator if the comment is resolved.
  },
  "comment": { # The general pull request comment. # Optional. The general pull request comment.
    "body": "A String", # Required. The comment body.
  },
  "createTime": "A String", # Output only. Creation timestamp.
  "name": "A String", # Identifier. Unique identifier for the pull request comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}`
  "review": { # The review summary comment. # Optional. The review summary comment.
    "actionType": "A String", # Required. The review action type.
    "body": "A String", # Optional. The comment body.
    "effectiveCommitSha": "A String", # Output only. The effective commit sha this review is pointing to.
  },
  "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 comment resource by the update. Updatable fields are `body`.
  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.
  },
}

resolve(parent, body=None, x__xgafv=None)

Resolves pull request comments.

Args:
parent: string, Required. The pull request in which to resolve the pull request comments. 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:

{ # The request to resolve multiple pull request comments.
"autoFill": True or False, # Optional. If set, at least one comment in a thread is required, rest of the comments in the same thread will be automatically updated to resolved. If unset, all comments in the same thread need be present.
"names": [ # Required. The names of the pull request comments to resolve. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}` Only comments from the same threads are allowed in the same request.
"A String",
],
}

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.
},
}

unresolve(parent, body=None, x__xgafv=None)

Unresolves pull request comment.

Args:
parent: string, Required. The pull request in which to resolve the pull request comments. 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:

{ # The request to unresolve multiple pull request comments.
"autoFill": True or False, # Optional. If set, at least one comment in a thread is required, rest of the comments in the same thread will be automatically updated to unresolved. If unset, all comments in the same thread need be present.
"names": [ # Required. The names of the pull request comments to unresolve. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}` Only comments from the same threads are allowed in the same request.
"A String",
],
}

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.
},
}

Secure Source Manager API . projects . locations . repositories . pullRequests . pullRequestComments

Instance Methods

Method Details