Documentation

Google_Service_ContainerAnalysis_Resource_ProjectsNotes extends Google_Service_Resource
in package

Application

The "notes" collection of methods.

Typical usage is: $containeranalysisService = new Google_Service_ContainerAnalysis(...); $notes = $containeranalysisService->notes;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_ContainerAnalysis_Note: Creates a new `Note`. (notes.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_ContainerAnalysis_ContaineranalysisEmpty: Deletes the given `Note` from the system. (notes.delete)
get() : Google_Service_ContainerAnalysis_Note: Returns the requested `Note`. (notes.get)
getIamPolicy() : Google_Service_ContainerAnalysis_Policy: Gets the access control policy for a note or an `Occurrence` resource.
listProjectsNotes() : Google_Service_ContainerAnalysis_ListNotesResponse: Lists all `Notes` for a given project. (notes.listProjectsNotes)
patch() : Google_Service_ContainerAnalysis_Note: Updates an existing `Note`. (notes.patch)
setIamPolicy() : Google_Service_ContainerAnalysis_Policy: Sets the access control policy on the specified `Note` or `Occurrence`.
testIamPermissions() : Google_Service_ContainerAnalysis_TestIamPermissionsResponse: Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` (notes.testIamPermissions)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a new `Note`. (notes.create)


    public
                create(string $parent, Google_Service_ContainerAnalysis_Note $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_Note

Parameters

$parent : string: This field contains the project Id for example: "projects/{project_id}
$postBody : Google_Service_ContainerAnalysis_Note
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_Note —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes the given `Note` from the system. (notes.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_ContaineranalysisEmpty

Parameters

$name : string: The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_ContaineranalysisEmpty —

get()

Returns the requested `Note`. (notes.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_Note

Parameters

$name : string: The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_Note —

getIamPolicy()

Gets the access control policy for a note or an `Occurrence` resource.


    public
                getIamPolicy(string $resource, Google_Service_ContainerAnalysis_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_Policy

Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a PERMISSION_DENIED error. Attempting to call this method on a non-existent resource will result in a NOT_FOUND error if the user has list permission on the project, or a PERMISSION_DENIED error otherwise. The resource takes the following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID} for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes (notes.getIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_ContainerAnalysis_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_Policy —

listProjectsNotes()

Lists all `Notes` for a given project. (notes.listProjectsNotes)


    public
                listProjectsNotes(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_ListNotesResponse

Parameters

$parent : string: This field contains the project Id for example: "projects/{PROJECT_ID}".
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_ListNotesResponse —

patch()

Updates an existing `Note`. (notes.patch)


    public
                patch(string $name, Google_Service_ContainerAnalysis_Note $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_Note

Parameters

$name : string: The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}".
$postBody : Google_Service_ContainerAnalysis_Note
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_Note —

setIamPolicy()

Sets the access control policy on the specified `Note` or `Occurrence`.


    public
                setIamPolicy(string $resource, Google_Service_ContainerAnalysis_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_Policy

Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a Note or an Occurrence, respectively. Attempting to call this method without these permissions will result in a PERMISSION_DENIEDerror. Attempting to call this method on a non-existent resource will result in aNOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteorcontaineranalysis.occurrences.liston anOccurrence, or a PERMISSION_DENIEDerror otherwise. The resource takes the following formats:projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes (notes.setIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_ContainerAnalysis_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_Policy —

testIamPermissions()

Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` (notes.testIamPermissions)


    public
                testIamPermissions(string $resource, Google_Service_ContainerAnalysis_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ContainerAnalysis_TestIamPermissionsResponse

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_ContainerAnalysis_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ContainerAnalysis_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —