* $containeranalysisService = new Google\Service\ContainerAnalysis(...); * $notes = $containeranalysisService->projects_notes; * */ class ProjectsNotes extends \Google\Service\Resource { /** * Creates new notes in batch. (notes.batchCreate) * * @param string $parent Required. The name of the project in the form of * `projects/[PROJECT_ID]`, under which the notes are to be created. * @param BatchCreateNotesRequest $postBody * @param array $optParams Optional parameters. * @return BatchCreateNotesResponse * @throws \Google\Service\Exception */ public function batchCreate($parent, BatchCreateNotesRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('batchCreate', [$params], BatchCreateNotesResponse::class); } /** * Creates a new note. (notes.create) * * @param string $parent Required. The name of the project in the form of * `projects/[PROJECT_ID]`, under which the note is to be created. * @param Note $postBody * @param array $optParams Optional parameters. * * @opt_param string noteId Required. The ID to use for this note. * @return Note * @throws \Google\Service\Exception */ public function create($parent, Note $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Note::class); } /** * Deletes the specified note. (notes.delete) * * @param string $name Required. The name of the note in the form of * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param array $optParams Optional parameters. * @return ContaineranalysisEmpty * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], ContaineranalysisEmpty::class); } /** * Gets the specified note. (notes.get) * * @param string $name Required. The name of the note in the form of * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param array $optParams Optional parameters. * @return Note * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Note::class); } /** * 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) * * @param string $resource REQUIRED: The resource for which the policy is being * requested. See [Resource * names](https://cloud.google.com/apis/design/resource_names) for the * appropriate value for this field. * @param GetIamPolicyRequest $postBody * @param array $optParams Optional parameters. * @return Policy * @throws \Google\Service\Exception */ public function getIamPolicy($resource, GetIamPolicyRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('getIamPolicy', [$params], Policy::class); } /** * Lists notes for the specified project. (notes.listProjectsNotes) * * @param string $parent Required. The name of the project to list notes for in * the form of `projects/[PROJECT_ID]`. * @param array $optParams Optional parameters. * * @opt_param string filter The filter expression. * @opt_param int pageSize Number of notes to return in the list. Must be * positive. Max allowed page size is 1000. If not specified, page size defaults * to 20. * @opt_param string pageToken Token to provide to skip to a particular spot in * the list. * @return ListNotesResponse * @throws \Google\Service\Exception */ public function listProjectsNotes($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListNotesResponse::class); } /** * Updates the specified note. (notes.patch) * * @param string $name Required. The name of the note in the form of * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param Note $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask The fields to update. * @return Note * @throws \Google\Service\Exception */ public function patch($name, Note $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Note::class); } /** * 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) * * @param string $resource REQUIRED: The resource for which the policy is being * specified. See [Resource * names](https://cloud.google.com/apis/design/resource_names) for the * appropriate value for this field. * @param SetIamPolicyRequest $postBody * @param array $optParams Optional parameters. * @return Policy * @throws \Google\Service\Exception */ public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('setIamPolicy', [$params], Policy::class); } /** * 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) * * @param string $resource REQUIRED: The resource for which the policy detail is * being requested. See [Resource * names](https://cloud.google.com/apis/design/resource_names) for the * appropriate value for this field. * @param TestIamPermissionsRequest $postBody * @param array $optParams Optional parameters. * @return TestIamPermissionsResponse * @throws \Google\Service\Exception */ public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = []) { $params = ['resource' => $resource, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsNotes::class, 'Google_Service_ContainerAnalysis_Resource_ProjectsNotes');