Class: Google::Apis::CloudcontrolspartnerV1::CloudControlsPartnerServiceService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
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.

Examples:

require 'google/apis/cloudcontrolspartner_v1'

Cloudcontrolspartner = Google::Apis::CloudcontrolspartnerV1 # Alias the module
service = Cloudcontrolspartner::CloudControlsPartnerServiceService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://cloudcontrolspartner.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

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.

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.



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.

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.



46
47
48
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#get_organization_location_customer(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudcontrolspartnerV1::Customer

Gets details of a single customer

Parameters:

  • name (String) —

    Required. Format: organizations/organization/locations/location/customers/ customer``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



106
107
108
109
110
111
112
113
114
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 106

def get_organization_location_customer(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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

Parameters:

  • name (String) —

    Required. Format: organizations/organization/locations/location/customers/ customer/workloads/workload``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



182
183
184
185
186
187
188
189
190
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 182

def get_organization_location_customer_workload(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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

Parameters:

  • name (String) —

    Required. Format: organizations/organization/locations/location/customers/ customer/workloads/workload/ekmConnections

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



213
214
215
216
217
218
219
220
221
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 213

def get_organization_location_customer_workload_ekm_connections(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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

Parameters:

  • name (String) —

    Required. Name of the resource to get in the format: organizations/ organization/locations/location/customers/customer/workloads/workload/ partnerPermissions

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



245
246
247
248
249
250
251
252
253
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 245

def get_organization_location_customer_workload_partner_permissions(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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.

Parameters:

  • name (String) —

    Required. Format: organizations/organization/locations/location/customers/ customer/workloads/workload/violations/violation``

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



368
369
370
371
372
373
374
375
376
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 368

def get_organization_location_customer_workload_violation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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.

Parameters:

  • name (String) —

    Required. Format: organizations/organization/locations/location/partner

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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}', options)
  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.

Parameters:

  • parent (String) —

    Required. Parent resource Format: organizations/organization/locations/ location/customers/customer/workloads/workload``

  • filter (String) (defaults to: nil) —

    Optional. Filtering results.

  • order_by (String) (defaults to: nil) —

    Optional. Hint for how to order the results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of access requests to return. The service may return fewer than this value. If unspecified, at most 500 access requests will be returned.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListAccessApprovalRequests call. Provide this to retrieve the subsequent page.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 333

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', options)
  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``

Parameters:

  • parent (String) —

    Required. Parent resource Format organizations/organization/locations/ location/customers/customer/workloads/workload``

  • filter (String) (defaults to: nil) —

    Optional. Filtering results

  • interval_end_time (String) (defaults to: nil) —

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  • interval_start_time (String) (defaults to: nil) —

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • order_by (String) (defaults to: nil) —

    Optional. Hint for how to order the results

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListViolations call. Provide this to retrieve the subsequent page.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 420

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', options)
  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

Parameters:

  • parent (String) —

    Required. Parent resource Format: organizations/organization/locations/ location/customers/customer``

  • filter (String) (defaults to: nil) —

    Optional. Filtering results.

  • order_by (String) (defaults to: nil) —

    Optional. Hint for how to order the results.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListWorkloads call. Provide this to retrieve the subsequent page.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 286

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', options)
  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

Parameters:

  • parent (String) —

    Required. Parent resource Format: organizations/organization/locations/ location``

  • filter (String) (defaults to: nil) —

    Optional. Filtering results

  • order_by (String) (defaults to: nil) —

    Optional. Hint for how to order the results

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListCustomers call. Provide this to retrieve the subsequent page.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/apis/cloudcontrolspartner_v1/service.rb', line 147

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', options)
  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