class Google::Apis::OndemandscanningV1beta1::OnDemandScanningService

On-Demand Scanning API

A service to scan container images for vulnerabilities.

@example

require 'google/apis/ondemandscanning_v1beta1'

Ondemandscanning = Google::Apis::OndemandscanningV1beta1 # Alias the module
service = Ondemandscanning::OnDemandScanningService.new

@see cloud.google.com/container-analysis/docs/on-demand-scanning/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 45
def initialize
  super('https://ondemandscanning.googleapis.com/', '',
        client_name: 'google-apis-ondemandscanning_v1beta1',
        client_version: Google::Apis::OndemandscanningV1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

analyze_scan_packages(parent, analyze_packages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Initiates an analysis of the provided packages. @param [String] parent

Required. The parent of the resource for which analysis is requested. Format:
projects/[project_name]/locations/[location]

@param [Google::Apis::OndemandscanningV1beta1::AnalyzePackagesRequest] analyze_packages_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 263
def analyze_scan_packages(parent, analyze_packages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/scans:analyzePackages', options)
  command.request_representation = Google::Apis::OndemandscanningV1beta1::AnalyzePackagesRequest::Representation
  command.request_object = analyze_packages_request_object
  command.response_representation = Google::Apis::OndemandscanningV1beta1::Operation::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::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
cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. @param [String] name

The name of the operation resource to be cancelled.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 79
def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::OndemandscanningV1beta1::Empty::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::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_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code. UNIMPLEMENTED`. @param [String] name

The name of the operation resource to be deleted.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 112
def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::OndemandscanningV1beta1::Empty::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::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_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. @param [String] name

The name of the operation resource.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 143
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::OndemandscanningV1beta1::Operation::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::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
list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `“/v1/`name=users/*`/operations”` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. @param [String] name

The name of the operation's parent resource.

@param [String] filter

The standard list filter.

@param [Fixnum] page_size

The standard list page size.

@param [String] page_token

The standard list page token.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::ListOperationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 186
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::OndemandscanningV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::ListOperationsResponse
  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_location_scan_vulnerabilities(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists vulnerabilities resulting from a successfully completed scan. @param [String] parent

Required. The parent of the collection of Vulnerabilities being requested.
Format: projects/[project_name]/locations/[location]/scans/[scan_id]

@param [Fixnum] page_size

The number of vulnerabilities to retrieve.

@param [String] page_token

The page token, resulting from a previous call to ListVulnerabilities.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::ListVulnerabilitiesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::ListVulnerabilitiesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 300
def list_project_location_scan_vulnerabilities(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/vulnerabilities', options)
  command.response_representation = Google::Apis::OndemandscanningV1beta1::ListVulnerabilitiesResponse::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::ListVulnerabilitiesResponse
  command.params['parent'] = parent unless parent.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
wait_project_location_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code. UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. @param [String] name

The name of the operation resource to wait on.

@param [String] timeout

The maximum duration to wait before timing out. If left blank, the wait will
be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
context deadline is also specified, the shorter one will be used.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::OndemandscanningV1beta1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::OndemandscanningV1beta1::Operation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 230
def wait_project_location_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::OndemandscanningV1beta1::Operation::Representation
  command.response_class = Google::Apis::OndemandscanningV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/ondemandscanning_v1beta1/service.rb, line 314
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end