Show / Hide Table of Contents

Class ProvidersResource.NotesResource

The "notes" collection of methods.

Inheritance
System.Object
ProvidersResource.NotesResource
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.ContainerAnalysis.v1alpha1
Assembly: Google.Apis.ContainerAnalysis.v1alpha1.dll
Syntax
public class NotesResource

Constructors

NotesResource(IClientService)

Constructs a new resource.

Declaration
public NotesResource(IClientService service)
Parameters
Type Name Description
Google.Apis.Services.IClientService service

Properties

Occurrences

Gets the Occurrences resource.

Declaration
public virtual ProvidersResource.NotesResource.OccurrencesResource Occurrences { get; }
Property Value
Type Description
ProvidersResource.NotesResource.OccurrencesResource

Methods

Create(Note, String)

Creates a new Note.

Declaration
public virtual ProvidersResource.NotesResource.CreateRequest Create(Note body, string name)
Parameters
Type Name Description
Note body

The body of the request.

System.String name

The name of the project. Should be of the form "providers/{provider_id}". @Deprecated

Returns
Type Description
ProvidersResource.NotesResource.CreateRequest

Delete(String)

Deletes the given Note from the system.

Declaration
public virtual ProvidersResource.NotesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
System.String name

The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"

Returns
Type Description
ProvidersResource.NotesResource.DeleteRequest

Get(String)

Returns the requested Note.

Declaration
public virtual ProvidersResource.NotesResource.GetRequest Get(string name)
Parameters
Type Name Description
System.String name

The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"

Returns
Type Description
ProvidersResource.NotesResource.GetRequest

GetIamPolicy(GetIamPolicyRequest, String)

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

Declaration
public virtual ProvidersResource.NotesResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GetIamPolicyRequest body

The body of the request.

System.String resource

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type Description
ProvidersResource.NotesResource.GetIamPolicyRequest

List(String)

Lists all Notes for a given project.

Declaration
public virtual ProvidersResource.NotesResource.ListRequest List(string name)
Parameters
Type Name Description
System.String name

The name field will contain the project Id for example: "providers/{provider_id} @Deprecated

Returns
Type Description
ProvidersResource.NotesResource.ListRequest

Patch(Note, String)

Updates an existing Note.

Declaration
public virtual ProvidersResource.NotesResource.PatchRequest Patch(Note body, string name)
Parameters
Type Name Description
Note body

The body of the request.

System.String name

The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}".

Returns
Type Description
ProvidersResource.NotesResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, String)

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. Attempting to call this method without these permissions 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 containeranalysis.notes.list permission on a Note or containeranalysis.occurrences.list on an Occurrence, or a PERMISSION_DENIED error otherwise. The resource takes the following formats: projects/{projectid}/occurrences/{occurrenceid} for occurrences and projects/{projectid}/notes/{noteid} for notes

Declaration
public virtual ProvidersResource.NotesResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

System.String resource

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

Returns
Type Description
ProvidersResource.NotesResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, String)

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

Declaration
public virtual ProvidersResource.NotesResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

System.String resource

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type Description
ProvidersResource.NotesResource.TestIamPermissionsRequest
In This Article
Back to top