issue_comments
Creates, updates, deletes, gets or lists an issue_comments
resource.
Overview
Name | issue_comments |
Type | Resource |
Id | google.securesourcemanager.issue_comments |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Identifier. Unique identifier for an issue comment. The comment id is generated by the server. Format: projects/{project}/locations/{location}/repositories/{repository}/issues/{issue}/issueComments/{comment_id} |
body | string | Required. The comment body. |
createTime | string (google-datetime) | Output only. Creation timestamp. |
updateTime | string (google-datetime) | Output only. Last updated timestamp. |
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Identifier. Unique identifier for an issue comment. The comment id is generated by the server. Format: projects/{project}/locations/{location}/repositories/{repository}/issues/{issue}/issueComments/{comment_id} |
body | string | Required. The comment body. |
createTime | string (google-datetime) | Output only. Creation timestamp. |
updateTime | string (google-datetime) | Output only. Last updated timestamp. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | projectsId , locationsId , repositoriesId , issuesId , issueCommentsId | Gets an issue comment. | |
list | select | projectsId , locationsId , repositoriesId , issuesId | pageSize , pageToken | Lists comments in an issue. |
create | insert | projectsId , locationsId , repositoriesId , issuesId | Creates an issue comment. | |
patch | update | projectsId , locationsId , repositoriesId , issuesId , issueCommentsId | updateMask | Updates an issue comment. |
delete | delete | projectsId , locationsId , repositoriesId , issuesId , issueCommentsId | Deletes an issue comment. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
issueCommentsId | string | |
issuesId | string | |
locationsId | string | |
projectsId | string | |
repositoriesId | string | |
pageSize | integer (int32) | |
pageToken | string | |
updateMask | string (google-fieldmask) |
SELECT
examples
- get
- list
Gets an issue comment.
SELECT
name,
body,
createTime,
updateTime
FROM google.securesourcemanager.issue_comments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND issuesId = '{{ issuesId }}' -- required
AND issueCommentsId = '{{ issueCommentsId }}' -- required;
Lists comments in an issue.
SELECT
name,
body,
createTime,
updateTime
FROM google.securesourcemanager.issue_comments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND issuesId = '{{ issuesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
INSERT
examples
- create
- Manifest
Creates an issue comment.
INSERT INTO google.securesourcemanager.issue_comments (
data__name,
data__body,
projectsId,
locationsId,
repositoriesId,
issuesId
)
SELECT
'{{ name }}',
'{{ body }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ repositoriesId }}',
'{{ issuesId }}'
RETURNING
name,
done,
error,
metadata,
response
;
# Description fields are for documentation purposes
- name: issue_comments
props:
- name: projectsId
value: string
description: Required parameter for the issue_comments resource.
- name: locationsId
value: string
description: Required parameter for the issue_comments resource.
- name: repositoriesId
value: string
description: Required parameter for the issue_comments resource.
- name: issuesId
value: string
description: Required parameter for the issue_comments resource.
- name: name
value: string
description: >
Identifier. Unique identifier for an issue comment. The comment id is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/issues/{issue}/issueComments/{comment_id}`
- name: body
value: string
description: >
Required. The comment body.
UPDATE
examples
- patch
Updates an issue comment.
UPDATE google.securesourcemanager.issue_comments
SET
data__name = '{{ name }}',
data__body = '{{ body }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND repositoriesId = '{{ repositoriesId }}' --required
AND issuesId = '{{ issuesId }}' --required
AND issueCommentsId = '{{ issueCommentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;
DELETE
examples
- delete
Deletes an issue comment.
DELETE FROM google.securesourcemanager.issue_comments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND repositoriesId = '{{ repositoriesId }}' --required
AND issuesId = '{{ issuesId }}' --required
AND issueCommentsId = '{{ issueCommentsId }}' --required;