Class: Google::Apis::ChromepolicyV1::ChromePolicyService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/chromepolicy_v1/service.rb

Overview

Chrome Policy API

The Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.

Examples:

require 'google/apis/chromepolicy_v1'

Chromepolicy = Google::Apis::ChromepolicyV1 # Alias the module
service = Chromepolicy::ChromePolicyService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChromePolicyService

Returns a new instance of ChromePolicyService.



49
50
51
52
53
54
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-chromepolicy_v1',
        client_version: Google::Apis::ChromepolicyV1::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.



42
43
44
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 42

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.



47
48
49
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#batch_customer_policy_group_delete(customer, google_chrome_policy_versions_v1_batch_delete_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty

Delete multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc. Status.

Parameters:

  • customer (String) —

    ID of the Google Workspace account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_batch_delete_group_policies_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchDeleteGroupPoliciesRequest) (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:

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



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 118

def batch_customer_policy_group_delete(customer, google_chrome_policy_versions_v1_batch_delete_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/groups:batchDelete', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchDeleteGroupPoliciesRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_batch_delete_group_policies_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_customer_policy_group_modify(customer, google_chrome_policy_versions_v1_batch_modify_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty

Modify multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc. Status.

Parameters:

  • customer (String) —

    ID of the Google Workspace account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_batch_modify_group_policies_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchModifyGroupPoliciesRequest) (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:

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



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 157

def batch_customer_policy_group_modify(customer, google_chrome_policy_versions_v1_batch_modify_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/groups:batchModify', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchModifyGroupPoliciesRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_batch_modify_group_policies_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_customer_policy_orgunit_inherit(customer, google_chrome_policy_versions_v1_batch_inherit_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty

Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc. Status.

Parameters:

  • customer (String) —

    ID of the G Suite account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_batch_inherit_org_unit_policies_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchInheritOrgUnitPoliciesRequest) (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:

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



401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 401

def batch_customer_policy_orgunit_inherit(customer, google_chrome_policy_versions_v1_batch_inherit_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/orgunits:batchInherit', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchInheritOrgUnitPoliciesRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_batch_inherit_org_unit_policies_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_customer_policy_orgunit_modify(customer, google_chrome_policy_versions_v1_batch_modify_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty

Modify multiple policy values that are applied to a specific org unit. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc. Status.

Parameters:

  • customer (String) —

    ID of the G Suite account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_batch_modify_org_unit_policies_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchModifyOrgUnitPoliciesRequest) (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:

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



440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 440

def batch_customer_policy_orgunit_modify(customer, google_chrome_policy_versions_v1_batch_modify_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/orgunits:batchModify', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1BatchModifyOrgUnitPoliciesRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_batch_modify_org_unit_policies_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#define_customer_policy_network_certificate(customer, google_chrome_policy_versions_v1_define_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineCertificateResponse

Creates a certificate at a specified OU for a customer.

Parameters:

  • customer (String) —

    Required. The customer for which the certificate will apply.

  • google_chrome_policy_versions_v1_define_certificate_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineCertificateRequest) (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:

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



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

def define_customer_policy_network_certificate(customer, google_chrome_policy_versions_v1_define_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/networks:defineCertificate', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineCertificateRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_define_certificate_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineCertificateResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineCertificateResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#define_customer_policy_network_network(customer, google_chrome_policy_versions_v1_define_network_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineNetworkResponse

Define a new network.

Parameters:

  • customer (String) —

    Required. The customer who will own this new network.

  • google_chrome_policy_versions_v1_define_network_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineNetworkRequest) (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:

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



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 295

def define_customer_policy_network_network(customer, google_chrome_policy_versions_v1_define_network_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/networks:defineNetwork', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineNetworkRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_define_network_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineNetworkResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1DefineNetworkResponse
  command.params['customer'] = customer unless customer.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_customer_policy_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchema

Get a specific policy schema for a customer by its resource name.

Parameters:

  • name (String) —

    Required. The policy schema resource name to query.

  • 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



472
473
474
475
476
477
478
479
480
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 472

def get_customer_policy_schema(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchema::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchema
  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_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_versions_v1_list_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListGroupPriorityOrderingResponse

Retrieve a group priority ordering for an app. The target app must be supplied in additionalTargetKeyNames in the PolicyTargetKey. On failure the request will return the error details as part of the google.rpc.Status.

Parameters:

  • customer (String) —

    Required. ID of the Google Workspace account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_list_group_priority_ordering_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListGroupPriorityOrderingRequest) (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:

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



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 193

def list_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_versions_v1_list_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/groups:listGroupPriorityOrdering', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListGroupPriorityOrderingRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_list_group_priority_ordering_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListGroupPriorityOrderingResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListGroupPriorityOrderingResponse
  command.params['customer'] = customer unless customer.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_customer_policy_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListPolicySchemasResponse

Gets a list of policy schemas that match a specified filter value for a given customer.

Parameters:

  • parent (String) —

    Required. The customer for which the listing request will apply.

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

    The schema filter used to find a particular schema based on fields like its resource name, description and additionalTargetKeyNames.

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

    The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000.

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

    The page token used to retrieve a specific page of the listing 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:

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



511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 511

def list_customer_policy_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/policySchemas', options)
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListPolicySchemasResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ListPolicySchemasResponse
  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

#remove_customer_policy_network_certificate(customer, google_chrome_policy_versions_v1_remove_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveCertificateResponse

Remove an existing certificate by guid.

Parameters:

  • customer (String) —

    Required. The customer whose certificate will be removed.

  • google_chrome_policy_versions_v1_remove_certificate_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveCertificateRequest) (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:

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



328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 328

def remove_customer_policy_network_certificate(customer, google_chrome_policy_versions_v1_remove_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/networks:removeCertificate', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveCertificateRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_remove_certificate_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveCertificateResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveCertificateResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_customer_policy_network_network(customer, google_chrome_policy_versions_v1_remove_network_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveNetworkResponse

Remove an existing network by guid.

Parameters:

  • customer (String) —

    Required. The customer whose network will be removed.

  • google_chrome_policy_versions_v1_remove_network_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveNetworkRequest) (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:

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



361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 361

def remove_customer_policy_network_network(customer, google_chrome_policy_versions_v1_remove_network_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/networks:removeNetwork', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveNetworkRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_remove_network_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveNetworkResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1RemoveNetworkResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resolve_customer_policy(customer, google_chrome_policy_versions_v1_resolve_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ResolveResponse

Gets the resolved policy values for a list of policies that match a search query.

Parameters:

  • customer (String) —

    ID of the G Suite account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_resolve_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ResolveRequest) (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:

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



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 79

def resolve_customer_policy(customer, google_chrome_policy_versions_v1_resolve_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies:resolve', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ResolveRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_resolve_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ResolveResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1ResolveResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_versions_v1_update_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty

Update a group priority ordering for an app. The target app must be supplied in additionalTargetKeyNames in the PolicyTargetKey. On failure the request will return the error details as part of the google.rpc.Status.

Parameters:

  • customer (String) —

    Required. ID of the Google Workspace account or literal "my_customer" for the customer associated to the request.

  • google_chrome_policy_versions_v1_update_group_priority_ordering_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UpdateGroupPriorityOrderingRequest) (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:

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



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 229

def update_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_versions_v1_update_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+customer}/policies/groups:updateGroupPriorityOrdering', options)
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UpdateGroupPriorityOrderingRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_update_group_priority_ordering_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_medium(customer, google_chrome_policy_versions_v1_upload_policy_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UploadPolicyFileResponse

Creates an enterprise file from the content provided by user. Returns a public download url for end user.

Parameters:

  • customer (String) —

    Required. The customer for which the file upload will apply.

  • google_chrome_policy_versions_v1_upload_policy_file_request_object (Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UploadPolicyFileRequest) (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.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

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

    Content type of the uploaded content.

  • 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



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/google/apis/chromepolicy_v1/service.rb', line 550

def upload_medium(customer, google_chrome_policy_versions_v1_upload_policy_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v1/{+customer}/policies/files:uploadPolicyFile', options)
  else
    command = make_upload_command(:post, 'v1/{+customer}/policies/files:uploadPolicyFile', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UploadPolicyFileRequest::Representation
  command.request_object = google_chrome_policy_versions_v1_upload_policy_file_request_object
  command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UploadPolicyFileResponse::Representation
  command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1UploadPolicyFileResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end