Class: Google::Apis::ContaineranalysisV1alpha1::ContainerAnalysisService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/containeranalysis_v1alpha1/service.rb

Overview

Container Analysis API

An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts.

Examples:

require 'google/apis/containeranalysis_v1alpha1'

Containeranalysis = Google::Apis::ContaineranalysisV1alpha1 # Alias the module
service = Containeranalysis::ContainerAnalysisService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ ContainerAnalysisService

Returns a new instance of ContainerAnalysisService



46
47
48
49
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 46

def initialize
  super('https://containeranalysis.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#create_operation(parent, create_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Operation

Creates a new Operation.

Parameters:

  • parent (String) —

    The project Id that this operation should be created under.

  • create_operation_request_object (Google::Apis::ContaineranalysisV1alpha1::CreateOperationRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



808
809
810
811
812
813
814
815
816
817
818
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 808

def create_operation(parent, create_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+parent}/operations', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::CreateOperationRequest::Representation
  command.request_object = create_operation_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Operation::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_note(parent, note_object = nil, name: nil, note_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Creates a new Note.

Parameters:

  • parent (String) —

    This field contains the project Id for example: "projects/project_id

  • note_object (Google::Apis::ContaineranalysisV1alpha1::Note) (defaults to: nil)
  • name (String) —

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

  • note_id (String) —

    The ID to use for this note.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 79

def create_project_note(parent, note_object = nil, name: nil, note_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+parent}/notes', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.request_object = note_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['noteId'] = note_id unless note_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_occurrence(parent, occurrence_object = nil, name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Occurrence

Creates a new Occurrence. Use this method to create Occurrences for a resource.

Parameters:

  • parent (String) —

    This field contains the project Id for example: "projects/project_id"

  • occurrence_object (Google::Apis::ContaineranalysisV1alpha1::Occurrence) (defaults to: nil)
  • name (String) —

    The name of the project. Should be of the form "projects/project_id". @Deprecated

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 433

def create_project_occurrence(parent, occurrence_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+parent}/occurrences', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::Occurrence::Representation
  command.request_object = occurrence_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Occurrence::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Occurrence
  command.params['parent'] = parent unless parent.nil?
  command.query['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_provider_note(name, note_object = nil, note_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Creates a new Note.

Parameters:

  • name (String) —

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

  • note_object (Google::Apis::ContaineranalysisV1alpha1::Note) (defaults to: nil)
  • note_id (String) —

    The ID to use for this note.

  • parent (String) —

    This field contains the project Id for example: "projects/project_id

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 991

def create_provider_note(name, note_object = nil, note_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+name}/notes', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.request_object = note_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['name'] = name unless name.nil?
  command.query['noteId'] = note_id unless note_id.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_note(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Empty

Deletes the given Note from the system.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



114
115
116
117
118
119
120
121
122
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 114

def delete_project_note(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Empty::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_occurrence(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Empty

Deletes the given Occurrence from the system. Use this when an Occurrence is no longer applicable for the given resource.

Parameters:

  • name (String) —

    The name of the occurrence in the form of "projects/project_id/occurrences/OCCURRENCE_ID"

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



468
469
470
471
472
473
474
475
476
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 468

def delete_project_occurrence(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Empty::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_provider_note(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Empty

Deletes the given Note from the system.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1026

def delete_provider_note(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Empty::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_occurrence_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Policy

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

Parameters:

  • resource (String) —

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

  • get_iam_policy_request_object (Google::Apis::ContaineranalysisV1alpha1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



541
542
543
544
545
546
547
548
549
550
551
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 541

def get_occurrence_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Policy::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_note(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Returns the requested Note.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 145

def get_project_note(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_note_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Policy

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

Parameters:

  • resource (String) —

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

  • get_iam_policy_request_object (Google::Apis::ContaineranalysisV1alpha1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



187
188
189
190
191
192
193
194
195
196
197
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 187

def get_project_note_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Policy::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_occurrence(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Occurrence

Returns the requested Occurrence.

Parameters:

  • name (String) —

    The name of the occurrence of the form "projects/project_id/occurrences/OCCURRENCE_ID"

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



499
500
501
502
503
504
505
506
507
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 499

def get_project_occurrence(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Occurrence::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Occurrence
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_occurrence_notes(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Gets the Note attached to the given Occurrence.

Parameters:

  • name (String) —

    The name of the occurrence in the form "projects/project_id/occurrences/OCCURRENCE_ID"

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



574
575
576
577
578
579
580
581
582
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 574

def get_project_occurrence_notes(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}/notes', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_occurrence_vulnerability_summary(parent, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::GetVulnzOccurrencesSummaryResponse

Gets a summary of the number and severity of occurrences.

Parameters:

  • parent (String) —

    This contains the project Id for example: projects/project_id

  • filter (String) —

    The filter expression.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



606
607
608
609
610
611
612
613
614
615
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 606

def get_project_occurrence_vulnerability_summary(parent, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/occurrences:vulnerabilitySummary', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::GetVulnzOccurrencesSummaryResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::GetVulnzOccurrencesSummaryResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_scan_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ScanConfig

Gets a specific scan configuration for a project.

Parameters:

  • name (String) —

    The name of the ScanConfig in the form projects/project_id/scanConfigs/scan_config_id

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



877
878
879
880
881
882
883
884
885
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 877

def get_project_scan_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ScanConfig::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ScanConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_provider_note(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Returns the requested Note.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1057

def get_provider_note(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_provider_note_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Policy

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

Parameters:

  • resource (String) —

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

  • get_iam_policy_request_object (Google::Apis::ContaineranalysisV1alpha1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1099

def get_provider_note_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Policy::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_note_occurrences(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ListNoteOccurrencesResponse

Lists Occurrences referencing the specified Note. Use this method to get all occurrences referencing your Note across all your customer projects.

Parameters:

  • name (String) —

    The name field will contain the note name for example: "provider/provider_id/notes/note_id"

  • filter (String) —

    The filter expression.

  • page_size (Fixnum) —

    Number of notes to return in the list.

  • page_token (String) —

    Token to provide to skip to a particular spot in the list.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 395

def list_project_note_occurrences(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}/occurrences', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ListNoteOccurrencesResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ListNoteOccurrencesResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_notes(parent, filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ListNotesResponse

Lists all Notes for a given project.

Parameters:

  • parent (String) —

    This field contains the project Id for example: "projects/PROJECT_ID".

  • filter (String) —

    The filter expression.

  • name (String) —

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

  • page_size (Fixnum) —

    Number of notes to return in the list.

  • page_token (String) —

    Token to provide to skip to a particular spot in the list.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 229

def list_project_notes(parent, filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/notes', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ListNotesResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ListNotesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_occurrences(parent, filter: nil, kind: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ListOccurrencesResponse

Lists active Occurrences for a given project matching the filters.

Parameters:

  • parent (String) —

    This contains the project Id for example: projects/project_id.

  • filter (String) —

    The filter expression.

  • kind (String) —

    The kind of occurrences to filter on.

  • name (String) —

    The name field contains the project Id. For example: "projects/project_id @Deprecated

  • page_size (Fixnum) —

    Number of occurrences to return in the list.

  • page_token (String) —

    Token to provide to skip to a particular spot in the list.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 649

def list_project_occurrences(parent, filter: nil, kind: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/occurrences', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ListOccurrencesResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ListOccurrencesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['kind'] = kind unless kind.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_scan_configs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ListScanConfigsResponse

Lists scan configurations for a project.

Parameters:

  • parent (String) —

    This containers the project Id i.e.: projects/project_id

  • filter (String) —

    The filter expression.

  • page_size (Fixnum) —

    The number of items to return.

  • page_token (String) —

    The page token to use for the next request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 913

def list_project_scan_configs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/scanConfigs', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ListScanConfigsResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ListScanConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_provider_note_occurrences(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ListNoteOccurrencesResponse

Lists Occurrences referencing the specified Note. Use this method to get all occurrences referencing your Note across all your customer projects.

Parameters:

  • name (String) —

    The name field will contain the note name for example: "provider/provider_id/notes/note_id"

  • filter (String) —

    The filter expression.

  • page_size (Fixnum) —

    Number of notes to return in the list.

  • page_token (String) —

    Token to provide to skip to a particular spot in the list.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1307

def list_provider_note_occurrences(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}/occurrences', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ListNoteOccurrencesResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ListNoteOccurrencesResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_provider_notes(name, filter: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ListNotesResponse

Lists all Notes for a given project.

Parameters:

  • name (String) —

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

  • filter (String) —

    The filter expression.

  • page_size (Fixnum) —

    Number of notes to return in the list.

  • page_token (String) —

    Token to provide to skip to a particular spot in the list.

  • parent (String) —

    This field contains the project Id for example: "projects/PROJECT_ID".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1141

def list_provider_notes(name, filter: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}/notes', options)
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ListNotesResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ListNotesResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_note(name, note_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Updates an existing Note.

Parameters:

  • name (String) —

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

  • note_object (Google::Apis::ContaineranalysisV1alpha1::Note) (defaults to: nil)
  • update_mask (String) —

    The fields to update.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 267

def patch_project_note(name, note_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.request_object = note_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_occurrence(name, occurrence_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Occurrence

Updates an existing occurrence.

Parameters:

  • name (String) —

    The name of the occurrence. Should be of the form "projects/project_id/occurrences/OCCURRENCE_ID".

  • occurrence_object (Google::Apis::ContaineranalysisV1alpha1::Occurrence) (defaults to: nil)
  • update_mask (String) —

    The fields to update.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 688

def patch_project_occurrence(name, occurrence_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::Occurrence::Representation
  command.request_object = occurrence_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Occurrence::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Occurrence
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_operation(name, update_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Operation

Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result.

Parameters:

  • name (String) —

    The name of the Operation. Should be of the form "projects/provider_id/operations/operation_id".

  • update_operation_request_object (Google::Apis::ContaineranalysisV1alpha1::UpdateOperationRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



844
845
846
847
848
849
850
851
852
853
854
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 844

def patch_project_operation(name, update_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::UpdateOperationRequest::Representation
  command.request_object = update_operation_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Operation::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_scan_config(name, scan_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::ScanConfig

Updates the scan configuration to a new value.

Parameters:

  • name (String) —

    The scan config to update of the form projects/project_id/scanConfigs/scan_config_id.

  • scan_config_object (Google::Apis::ContaineranalysisV1alpha1::ScanConfig) (defaults to: nil)
  • update_mask (String) —

    The fields to update.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 950

def patch_project_scan_config(name, scan_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::ScanConfig::Representation
  command.request_object = scan_config_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::ScanConfig::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::ScanConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_provider_note(name, note_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Note

Updates an existing Note.

Parameters:

  • name (String) —

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

  • note_object (Google::Apis::ContaineranalysisV1alpha1::Note) (defaults to: nil)
  • update_mask (String) —

    The fields to update.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1179

def patch_provider_note(name, note_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.request_object = note_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Note::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Note
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_occurrence_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Policy

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_DENIEDerror. Attempting to call this method on a non-existent resource will result in a NOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteorcontaineranalysis.occurrences.liston anOccurrence, or aPERMISSION_DENIEDerror otherwise. The resource takes the following formats:projects/projectid/occurrences/occurrenceidfor occurrences and projects/projectid/notes/noteid` for notes

Parameters:

  • resource (String) —

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

  • set_iam_policy_request_object (Google::Apis::ContaineranalysisV1alpha1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



734
735
736
737
738
739
740
741
742
743
744
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 734

def set_occurrence_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Policy::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_note_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Policy

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_DENIEDerror. Attempting to call this method on a non-existent resource will result in a NOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteorcontaineranalysis.occurrences.liston anOccurrence, or aPERMISSION_DENIEDerror otherwise. The resource takes the following formats:projects/projectid/occurrences/occurrenceidfor occurrences and projects/projectid/notes/noteid` for notes

Parameters:

  • resource (String) —

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

  • set_iam_policy_request_object (Google::Apis::ContaineranalysisV1alpha1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



313
314
315
316
317
318
319
320
321
322
323
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 313

def set_project_note_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Policy::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_provider_note_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::Policy

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_DENIEDerror. Attempting to call this method on a non-existent resource will result in a NOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteorcontaineranalysis.occurrences.liston anOccurrence, or aPERMISSION_DENIEDerror otherwise. The resource takes the following formats:projects/projectid/occurrences/occurrenceidfor occurrences and projects/projectid/notes/noteid` for notes

Parameters:

  • resource (String) —

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

  • set_iam_policy_request_object (Google::Apis::ContaineranalysisV1alpha1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1225

def set_provider_note_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::Policy::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_occurrence_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::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_IDfor `Occurrences` and `projects/`PROJECT_ID`/notes/`NOTE_ID for Notes

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.

  • test_iam_permissions_request_object (Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



775
776
777
778
779
780
781
782
783
784
785
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 775

def test_occurrence_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_note_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::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_IDfor `Occurrences` and `projects/`PROJECT_ID`/notes/`NOTE_ID for Notes

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.

  • test_iam_permissions_request_object (Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



354
355
356
357
358
359
360
361
362
363
364
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 354

def test_project_note_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_provider_note_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ContaineranalysisV1alpha1::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_IDfor `Occurrences` and `projects/`PROJECT_ID`/notes/`NOTE_ID for Notes

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.

  • test_iam_permissions_request_object (Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1266

def test_provider_note_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ContaineranalysisV1alpha1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end