Class: Google::Apis::AndroidmanagementV1::AndroidManagementService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/androidmanagement_v1/service.rb

Overview

Android Management API

The Android Management API provides remote enterprise management of Android devices and apps.

Examples:

require 'google/apis/androidmanagement_v1'

Androidmanagement = Google::Apis::AndroidmanagementV1 # Alias the module
service = Androidmanagement::AndroidManagementService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeAndroidManagementService

Returns a new instance of AndroidManagementService.


46
47
48
49
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 46

def initialize
  super('https://androidmanagement.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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.


39
40
41
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 39

def key
  @key
end

#quota_userString

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.


44
45
46
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#cancel_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::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.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

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


401
402
403
404
405
406
407
408
409
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 401

def cancel_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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

#create_enterprise(enterprise_object = nil, enterprise_token: nil, project_id: nil, signup_url_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Enterprise

Creates an enterprise. This is the last step in the enterprise signup flow.

Parameters:

  • enterprise_object (Google::Apis::AndroidmanagementV1::Enterprise) (defaults to: nil)
  • enterprise_token (String) (defaults to: nil)

    The enterprise token appended to the callback URL.

  • project_id (String) (defaults to: nil)

    The ID of the Google Cloud Platform project which will own the enterprise.

  • signup_url_name (String) (defaults to: nil)

    The name of the SignupUrl used to sign up for the enterprise.

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


76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 76

def create_enterprise(enterprise_object = nil, enterprise_token: nil, project_id: nil, signup_url_name: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/enterprises', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation
  command.request_object = enterprise_object
  command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Enterprise
  command.query['enterpriseToken'] = enterprise_token unless enterprise_token.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['signupUrlName'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_enterprise_enrollment_token(parent, enrollment_token_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::EnrollmentToken

Creates an enrollment token for a given enterprise.

Parameters:

  • parent (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • enrollment_token_object (Google::Apis::AndroidmanagementV1::EnrollmentToken) (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:


542
543
544
545
546
547
548
549
550
551
552
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 542

def create_enterprise_enrollment_token(parent, enrollment_token_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/enrollmentTokens', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::EnrollmentToken::Representation
  command.request_object = enrollment_token_object
  command.response_representation = Google::Apis::AndroidmanagementV1::EnrollmentToken::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::EnrollmentToken
  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

#create_enterprise_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::WebApp

Creates a web app.

Parameters:

  • parent (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • web_app_object (Google::Apis::AndroidmanagementV1::WebApp) (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:


745
746
747
748
749
750
751
752
753
754
755
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 745

def create_enterprise_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/webApps', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::WebApp
  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

#create_enterprise_web_token(parent, web_token_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::WebToken

Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.

Parameters:

  • parent (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • web_token_object (Google::Apis::AndroidmanagementV1::WebToken) (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:


916
917
918
919
920
921
922
923
924
925
926
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 916

def create_enterprise_web_token(parent, web_token_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/webTokens', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::WebToken::Representation
  command.request_object = web_token_object
  command.response_representation = Google::Apis::AndroidmanagementV1::WebToken::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::WebToken
  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

#create_signup_url(callback_url: nil, project_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::SignupUrl

Creates an enterprise signup URL.

Parameters:

  • callback_url (String) (defaults to: nil)

    The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.

  • project_id (String) (defaults to: nil)

    The ID of the Google Cloud Platform project which will own the enterprise.

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


955
956
957
958
959
960
961
962
963
964
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 955

def (callback_url: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/signupUrls', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::SignupUrl::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::SignupUrl
  command.query['callbackUrl'] = callback_url unless callback_url.nil?
  command.query['projectId'] = project_id unless project_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_enterprise_device(name, wipe_data_flags: nil, wipe_reason_message: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Empty

Deletes a device. This operation wipes the device.

Parameters:

  • name (String)

    The name of the device in the form enterprises/enterpriseId/devices/ deviceId.

  • wipe_data_flags (Array<String>, String) (defaults to: nil)

    Optional flags that control the device wiping behavior.

  • wipe_reason_message (String) (defaults to: nil)

    Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.

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


220
221
222
223
224
225
226
227
228
229
230
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 220

def delete_enterprise_device(name, wipe_data_flags: nil, wipe_reason_message: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['wipeDataFlags'] = wipe_data_flags unless wipe_data_flags.nil?
  command.query['wipeReasonMessage'] = wipe_reason_message unless wipe_reason_message.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_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::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.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

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


434
435
436
437
438
439
440
441
442
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 434

def delete_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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_enterprise_enrollment_token(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Empty

Deletes an enrollment token. This operation invalidates the token, preventing its future use.

Parameters:

  • name (String)

    The name of the enrollment token in the form enterprises/enterpriseId/ enrollmentTokens/enrollmentTokenId.

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


576
577
578
579
580
581
582
583
584
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 576

def delete_enterprise_enrollment_token(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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_enterprise_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Empty

Deletes a policy. This operation is only permitted if no devices are currently referencing the policy.

Parameters:

  • name (String)

    The name of the policy in the form enterprises/enterpriseId/policies/ policyId.

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


608
609
610
611
612
613
614
615
616
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 608

def delete_enterprise_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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_enterprise_web_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Empty

Deletes a web app.

Parameters:

  • name (String)

    The name of the web app in the form enterprises/enterpriseId/webApps/ packageName.

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


778
779
780
781
782
783
784
785
786
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 778

def delete_enterprise_web_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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_enterprise(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Enterprise

Gets an enterprise.

Parameters:

  • name (String)

    The name of the enterprise in the form enterprises/enterpriseId.

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


110
111
112
113
114
115
116
117
118
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 110

def get_enterprise(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Enterprise
  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_enterprise_application(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Application

Gets info about an application.

Parameters:

  • name (String)

    The name of the application in the form enterprises/enterpriseId/ applications/package_name.

  • language_code (String) (defaults to: nil)

    The preferred language for localized application info, as a BCP47 tag (e.g. " en-US", "de"). If not specified the default language of the application will be used.

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


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

def get_enterprise_application(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Application::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Application
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.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_enterprise_device(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Device

Gets a device.

Parameters:

  • name (String)

    The name of the device in the form enterprises/enterpriseId/devices/ deviceId.

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


253
254
255
256
257
258
259
260
261
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 253

def get_enterprise_device(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Device::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Device
  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_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::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.

Parameters:

  • name (String)

    The name of the operation resource.

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


465
466
467
468
469
470
471
472
473
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 465

def get_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Operation::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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

#get_enterprise_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Policy

Gets a policy.

Parameters:

  • name (String)

    The name of the policy in the form enterprises/enterpriseId/policies/ policyId.

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


639
640
641
642
643
644
645
646
647
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 639

def get_enterprise_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::Policy::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Policy
  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_enterprise_web_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::WebApp

Gets a web app.

Parameters:

  • name (String)

    The name of the web app in the form enterprises/enterpriseId/webApp/ packageName.

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


809
810
811
812
813
814
815
816
817
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 809

def get_enterprise_web_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::WebApp
  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

#issue_enterprise_device_command(name, command_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Operation

Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.

Parameters:

  • name (String)

    The name of the device in the form enterprises/enterpriseId/devices/ deviceId.

  • command_object (Google::Apis::AndroidmanagementV1::Command) (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:


287
288
289
290
291
292
293
294
295
296
297
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 287

def issue_enterprise_device_command(name, command_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:issueCommand', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::Command::Representation
  command.request_object = command_object
  command.response_representation = Google::Apis::AndroidmanagementV1::Operation::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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_enterprise_device_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::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.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

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


508
509
510
511
512
513
514
515
516
517
518
519
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 508

def list_enterprise_device_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroidmanagementV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::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_enterprise_devices(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::ListDevicesResponse

Lists devices for a given enterprise.

Parameters:

  • parent (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • page_size (Fixnum) (defaults to: nil)

    The requested page size. The actual page size may be fixed to a min or max value.

  • page_token (String) (defaults to: nil)

    A token identifying a page of results returned by the server.

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


324
325
326
327
328
329
330
331
332
333
334
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 324

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

#list_enterprise_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::ListPoliciesResponse

Lists policies for a given enterprise.

Parameters:

  • parent (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • page_size (Fixnum) (defaults to: nil)

    The requested page size. The actual page size may be fixed to a min or max value.

  • page_token (String) (defaults to: nil)

    A token identifying a page of results returned by the server.

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


674
675
676
677
678
679
680
681
682
683
684
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 674

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

#list_enterprise_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::ListWebAppsResponse

Lists web apps for a given enterprise.

Parameters:

  • parent (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • page_size (Fixnum) (defaults to: nil)

    The requested page size. The actual page size may be fixed to a min or max value.

  • page_token (String) (defaults to: nil)

    A token identifying a page of results returned by the server.

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


844
845
846
847
848
849
850
851
852
853
854
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 844

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

#patch_enterprise(name, enterprise_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Enterprise

Updates an enterprise.

Parameters:

  • name (String)

    The name of the enterprise in the form enterprises/enterpriseId.

  • enterprise_object (Google::Apis::AndroidmanagementV1::Enterprise) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The field mask indicating the fields to update. If not set, all modifiable fields will be modified.

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


144
145
146
147
148
149
150
151
152
153
154
155
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 144

def patch_enterprise(name, enterprise_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation
  command.request_object = enterprise_object
  command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Enterprise
  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

#patch_enterprise_device(name, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Device

Updates a device.

Parameters:

  • name (String)

    The name of the device in the form enterprises/enterpriseId/devices/ deviceId.

  • device_object (Google::Apis::AndroidmanagementV1::Device) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The field mask indicating the fields to update. If not set, all modifiable fields will be modified.

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


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

def patch_enterprise_device(name, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::Device::Representation
  command.request_object = device_object
  command.response_representation = Google::Apis::AndroidmanagementV1::Device::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Device
  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

#patch_enterprise_policy(name, policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::Policy

Updates or creates a policy.

Parameters:

  • name (String)

    The name of the policy in the form enterprises/enterpriseId/policies/ policyId.

  • policy_object (Google::Apis::AndroidmanagementV1::Policy) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The field mask indicating the fields to update. If not set, all modifiable fields will be modified.

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


711
712
713
714
715
716
717
718
719
720
721
722
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 711

def patch_enterprise_policy(name, policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::AndroidmanagementV1::Policy::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::Policy
  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

#patch_enterprise_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidmanagementV1::WebApp

Updates a web app.

Parameters:

  • name (String)

    The name of the web app in the form enterprises/enterpriseId/webApps/ packageName.

  • web_app_object (Google::Apis::AndroidmanagementV1::WebApp) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The field mask indicating the fields to update. If not set, all modifiable fields will be modified.

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


881
882
883
884
885
886
887
888
889
890
891
892
# File 'generated/google/apis/androidmanagement_v1/service.rb', line 881

def patch_enterprise_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidmanagementV1::WebApp
  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