1. class
  2. Google
  3. \
  4. Service
  5. \
  6. ContainerAnalysis
  7. \
  8. Resource
  9. \
  10. ProjectsNotes

ProjectsNotes

class ProjectsNotes extends Resource (View source)

The "notes" collection of methods.

Typical usage is:

 $containeranalysisService = new Google\Service\ContainerAnalysis(...);
 $notes = $containeranalysisService->projects_notes;

Methods

BatchCreateNotesResponse
batchCreate(string $parent, BatchCreateNotesRequest $postBody, array $optParams = [])

Creates new notes in batch. (notes.batchCreate)

Note
create(string $parent, Note $postBody, array $optParams = [])

Creates a new note. (notes.create)

ContaineranalysisEmpty
delete(string $name, array $optParams = [])

Deletes the specified note. (notes.delete)

Note
get(string $name, array $optParams = [])

Gets the specified note. (notes.get)

Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a note or an occurrence resource. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or occurrence, respectively. The resource takes the format projects/[PROJECT_ID]/notes/[NOTE_ID] for notes and projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID] for occurrences.

ListNotesResponse
listProjectsNotes(string $parent, array $optParams = [])

Lists notes for the specified project. (notes.listProjectsNotes)

Note
patch(string $name, Note $postBody, array $optParams = [])

Updates the specified note. (notes.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified note or occurrence. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or an occurrence, respectively. The resource takes the format projects/[PROJECT_ID]/notes/[NOTE_ID] for notes and projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID] for occurrences.

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, containeranalysis.notes.list). The resource takes the format projects/[PROJECT_ID]/notes/[NOTE_ID] for notes and projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID] for occurrences.

Details

at line 51
BatchCreateNotesResponse batchCreate(string $parent, BatchCreateNotesRequest $postBody, array $optParams = [])

Creates new notes in batch. (notes.batchCreate)

Parameters

string $parent

Required. The name of the project in the form of projects/[PROJECT_ID], under which the notes are to be created.
BatchCreateNotesRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchCreateNotesResponse

Exceptions

Exception

at line 69
Note create(string $parent, Note $postBody, array $optParams = [])

Creates a new note. (notes.create)

Parameters

string $parent

Required. The name of the project in the form of projects/[PROJECT_ID], under which the note is to be created.
Note $postBody
array $optParams

Optional parameters.

Return Value

Note

Exceptions

Exception

at line 84
ContaineranalysisEmpty delete(string $name, array $optParams = [])

Deletes the specified note. (notes.delete)

Parameters

string $name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
array $optParams

Optional parameters.

Return Value

ContaineranalysisEmpty

Exceptions

Exception

at line 99
Note get(string $name, array $optParams = [])

Gets the specified note. (notes.get)

Parameters

string $name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
array $optParams

Optional parameters.

Return Value

Note

Exceptions

Exception

at line 123
Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a note or an occurrence resource. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or occurrence, respectively. The resource takes the format projects/[PROJECT_ID]/notes/[NOTE_ID] for notes and projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID] for occurrences.

(notes.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 145
ListNotesResponse listProjectsNotes(string $parent, array $optParams = [])

Lists notes for the specified project. (notes.listProjectsNotes)

Parameters

string $parent

Required. The name of the project to list notes for in the form of projects/[PROJECT_ID].
array $optParams

Optional parameters.

Return Value

ListNotesResponse

Exceptions

Exception

at line 163
Note patch(string $name, Note $postBody, array $optParams = [])

Updates the specified note. (notes.patch)

Parameters

string $name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
Note $postBody
array $optParams

Optional parameters.

Return Value

Note

Exceptions

Exception

at line 187
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified note or occurrence. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or an occurrence, respectively. The resource takes the format projects/[PROJECT_ID]/notes/[NOTE_ID] for notes and projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID] for occurrences.

(notes.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 210
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, containeranalysis.notes.list). The resource takes the format projects/[PROJECT_ID]/notes/[NOTE_ID] for notes and projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID] for occurrences.

(notes.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception