Class: Google::Apis::CloudcontrolspartnerV1::CloudControlsPartnerServiceService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::CloudcontrolspartnerV1::CloudControlsPartnerServiceService
- Defined in:
- lib/google/apis/cloudcontrolspartner_v1/service.rb
Overview
Cloud Controls Partner API
Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://cloudcontrolspartner.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#create_organization_location_customer(parent, customer_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer
Creates a new customer.
-
#delete_organization_location_customer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Empty
Delete details of a single customer.
-
#get_organization_location_customer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer
Gets details of a single customer.
-
#get_organization_location_customer_workload(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Workload
Gets details of a single workload.
-
#get_organization_location_customer_workload_ekm_connections(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::EkmConnections
Gets the EKM connections associated with a workload.
-
#get_organization_location_customer_workload_partner_permissions(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::PartnerPermissions
Gets the partner permissions granted for a workload.
-
#get_organization_location_customer_workload_violation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Violation
Gets details of a single Violation.
-
#get_organization_location_partner(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Partner
Get details of a Partner.
-
#initialize ⇒ CloudControlsPartnerServiceService
constructor
A new instance of CloudControlsPartnerServiceService.
-
#list_organization_location_customer_workload_access_approval_requests(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListAccessApprovalRequestsResponse
Deprecated: Only returns access approval requests directly associated with an assured workload folder.
-
#list_organization_location_customer_workload_violations(parent, filter: nil, interval_end_time: nil, interval_start_time: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListViolationsResponse
Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of
customer
&workload
. -
#list_organization_location_customer_workloads(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListWorkloadsResponse
Lists customer workloads for a given customer org id.
-
#list_organization_location_customers(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListCustomersResponse
Lists customers of a partner identified by its Google Cloud organization ID.
-
#patch_organization_location_customer(name, customer_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer
Update details of a single customer.
Constructor Details
#initialize ⇒ CloudControlsPartnerServiceService
Returns a new instance of CloudControlsPartnerServiceService.
48 49 50 51 52 53 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 48 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-cloudcontrolspartner_v1', client_version: Google::Apis::CloudcontrolspartnerV1::GEM_VERSION) @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.
41 42 43 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 41 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.
46 47 48 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 46 def quota_user @quota_user end |
Instance Method Details
#create_organization_location_customer(parent, customer_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer
Creates a new customer.
111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 111 def create_organization_location_customer(parent, customer_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/customers', ) command.request_representation = Google::Apis::CloudcontrolspartnerV1::Customer::Representation command.request_object = customer_object command.response_representation = Google::Apis::CloudcontrolspartnerV1::Customer::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::Customer command.params['parent'] = parent unless parent.nil? command.query['customerId'] = customer_id unless customer_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 |
#delete_organization_location_customer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Empty
Delete details of a single customer
145 146 147 148 149 150 151 152 153 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 145 def delete_organization_location_customer(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::Empty::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::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_location_customer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer
Gets details of a single customer
176 177 178 179 180 181 182 183 184 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 176 def get_organization_location_customer(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::Customer::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::Customer 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_location_customer_workload(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Workload
Gets details of a single workload
289 290 291 292 293 294 295 296 297 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 289 def get_organization_location_customer_workload(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::Workload::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::Workload 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_location_customer_workload_ekm_connections(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::EkmConnections
Gets the EKM connections associated with a workload
320 321 322 323 324 325 326 327 328 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 320 def get_organization_location_customer_workload_ekm_connections(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::EkmConnections::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::EkmConnections 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_location_customer_workload_partner_permissions(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::PartnerPermissions
Gets the partner permissions granted for a workload
352 353 354 355 356 357 358 359 360 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 352 def (name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::PartnerPermissions::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::PartnerPermissions 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_location_customer_workload_violation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Violation
Gets details of a single Violation.
475 476 477 478 479 480 481 482 483 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 475 def get_organization_location_customer_workload_violation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::Violation::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::Violation 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_location_partner(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Partner
Get details of a Partner.
75 76 77 78 79 80 81 82 83 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 75 def get_organization_location_partner(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::Partner::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::Partner 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_location_customer_workload_access_approval_requests(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListAccessApprovalRequestsResponse
Deprecated: Only returns access approval requests directly associated with an assured workload folder.
440 441 442 443 444 445 446 447 448 449 450 451 452 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 440 def list_organization_location_customer_workload_access_approval_requests(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/accessApprovalRequests', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::ListAccessApprovalRequestsResponse::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::ListAccessApprovalRequestsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.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_organization_location_customer_workload_violations(parent, filter: nil, interval_end_time: nil, interval_start_time: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListViolationsResponse
Lists Violations for a workload Callers may also choose to read across
multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard
character instead of customer
& workload
. Format: organizations/
organization/locations/
location/customers/
customer/workloads/
workload``
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 527 def list_organization_location_customer_workload_violations(parent, filter: nil, interval_end_time: nil, interval_start_time: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/violations', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::ListViolationsResponse::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::ListViolationsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil? command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil? command.query['orderBy'] = order_by unless order_by.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_organization_location_customer_workloads(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListWorkloadsResponse
Lists customer workloads for a given customer org id
393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 393 def list_organization_location_customer_workloads(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/workloads', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::ListWorkloadsResponse::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::ListWorkloadsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.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_organization_location_customers(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::ListCustomersResponse
Lists customers of a partner identified by its Google Cloud organization ID
217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 217 def list_organization_location_customers(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/customers', ) command.response_representation = Google::Apis::CloudcontrolspartnerV1::ListCustomersResponse::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::ListCustomersResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.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 |
#patch_organization_location_customer(name, customer_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer
Update details of a single customer
255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 255 def patch_organization_location_customer(name, customer_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::CloudcontrolspartnerV1::Customer::Representation command.request_object = customer_object command.response_representation = Google::Apis::CloudcontrolspartnerV1::Customer::Representation command.response_class = Google::Apis::CloudcontrolspartnerV1::Customer 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 |