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

#initializeContainerAnalysisService

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

#keyString

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_userString

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


797
798
799
800
801
802
803
804
805
806
807
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 797

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) (defaults to: nil)

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

  • note_id (String) (defaults to: nil)

    The ID to use for this note.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


425
426
427
428
429
430
431
432
433
434
435
436
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 425

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) (defaults to: nil)

    The ID to use for this note.

  • parent (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


977
978
979
980
981
982
983
984
985
986
987
988
989
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 977

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


111
112
113
114
115
116
117
118
119
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 111

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


460
461
462
463
464
465
466
467
468
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 460

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1011
1012
1013
1014
1015
1016
1017
1018
1019
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1011

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


532
533
534
535
536
537
538
539
540
541
542
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 532

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


141
142
143
144
145
146
147
148
149
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 141

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


182
183
184
185
186
187
188
189
190
191
192
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 182

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


491
492
493
494
495
496
497
498
499
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 491

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


565
566
567
568
569
570
571
572
573
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 565

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) (defaults to: nil)

    The filter expression.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


597
598
599
600
601
602
603
604
605
606
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 597

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


865
866
867
868
869
870
871
872
873
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 865

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1041
1042
1043
1044
1045
1046
1047
1048
1049
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1041

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1082

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) (defaults to: nil)

    The filter expression.

  • page_size (Fixnum) (defaults to: nil)

    Number of notes to return in the list.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


387
388
389
390
391
392
393
394
395
396
397
398
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 387

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) (defaults to: nil)

    The filter expression.

  • name (String) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

    Number of notes to return in the list.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 223

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) (defaults to: nil)

    The filter expression.

  • kind (String) (defaults to: nil)

    The kind of occurrences to filter on.

  • name (String) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

    Number of occurrences to return in the list.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


639
640
641
642
643
644
645
646
647
648
649
650
651
652
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 639

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) (defaults to: nil)

    The filter expression.

  • page_size (Fixnum) (defaults to: nil)

    The number of items to return.

  • page_token (String) (defaults to: nil)

    The page token to use for the next request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


901
902
903
904
905
906
907
908
909
910
911
912
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 901

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) (defaults to: nil)

    The filter expression.

  • page_size (Fixnum) (defaults to: nil)

    Number of notes to return in the list.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1287

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) (defaults to: nil)

    The filter expression.

  • page_size (Fixnum) (defaults to: nil)

    Number of notes to return in the list.

  • page_token (String) (defaults to: nil)

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

  • parent (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1123

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) (defaults to: nil)

    The fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


261
262
263
264
265
266
267
268
269
270
271
272
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 261

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) (defaults to: nil)

    The fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


678
679
680
681
682
683
684
685
686
687
688
689
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 678

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


832
833
834
835
836
837
838
839
840
841
842
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 832

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) (defaults to: nil)

    The fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


938
939
940
941
942
943
944
945
946
947
948
949
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 938

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) (defaults to: nil)

    The fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1161

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 aNOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteor containeranalysis.occurrences.liston anOccurrence, or a PERMISSION_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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


723
724
725
726
727
728
729
730
731
732
733
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 723

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 aNOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteor containeranalysis.occurrences.liston anOccurrence, or a PERMISSION_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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


306
307
308
309
310
311
312
313
314
315
316
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 306

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 aNOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteor containeranalysis.occurrences.liston anOccurrence, or a PERMISSION_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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1206

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


764
765
766
767
768
769
770
771
772
773
774
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 764

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


347
348
349
350
351
352
353
354
355
356
357
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 347

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
# File 'generated/google/apis/containeranalysis_v1alpha1/service.rb', line 1247

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