Class: Google::Apis::SecuritycenterV1p1alpha1::SecurityCommandCenterService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::SecuritycenterV1p1alpha1::SecurityCommandCenterService
- Defined in:
- generated/google/apis/securitycenter_v1p1alpha1/service.rb
Overview
Cloud Security Command Center API
Cloud Security Command Center API provides access to temporal views of assets and findings within an organization.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#cancel_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#delete_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::Empty
Deletes a long-running operation.
-
#get_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::Operation
Gets the latest state of a long-running operation.
-
#initialize ⇒ SecurityCommandCenterService
constructor
A new instance of SecurityCommandCenterService.
-
#list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse
Lists operations that match the specified filter in the request.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ SecurityCommandCenterService
Returns a new instance of SecurityCommandCenterService.
46 47 48 49 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/service.rb', line 46 def initialize super('https://securitycenter.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.
39 40 41 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/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.
44 45 46 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#cancel_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::Empty
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
.
80 81 82 83 84 85 86 87 88 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/service.rb', line 80 def cancel_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1p1alpha1/{+name}:cancel', ) command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::Empty::Representation command.response_class = Google::Apis::SecuritycenterV1p1alpha1::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_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::Empty
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
.
113 114 115 116 117 118 119 120 121 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/service.rb', line 113 def delete_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1p1alpha1/{+name}', ) command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::Empty::Representation command.response_class = Google::Apis::SecuritycenterV1p1alpha1::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_organization_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::Operation
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.
145 146 147 148 149 150 151 152 153 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/service.rb', line 145 def get_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1p1alpha1/{+name}', ) command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::Operation::Representation command.response_class = Google::Apis::SecuritycenterV1p1alpha1::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_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse
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.
189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'generated/google/apis/securitycenter_v1p1alpha1/service.rb', line 189 def list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1p1alpha1/{+name}', ) command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse::Representation command.response_class = Google::Apis::SecuritycenterV1p1alpha1::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 |