Class: Google::Apis::AndroidmanagementV1::Command

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/androidmanagement_v1/classes.rb,
lib/google/apis/androidmanagement_v1/representations.rb,
lib/google/apis/androidmanagement_v1/representations.rb

Overview

A command.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Command

Returns a new instance of Command.



1597
1598
1599
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1597

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#add_esim_params ⇒ Google::Apis::AndroidmanagementV1::AddEsimParams

Parameters associated with the ADD_ESIM command to add an eSIM profile to the device. Corresponds to the JSON property addEsimParams

Returns:



1486
1487
1488
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1486

def add_esim_params
  @add_esim_params
end

#clear_apps_data_params ⇒ Google::Apis::AndroidmanagementV1::ClearAppsDataParams

Parameters associated with the CLEAR_APP_DATA command to clear the data of specified apps from the device. Corresponds to the JSON property clearAppsDataParams

Returns:



1492
1493
1494
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1492

def clear_apps_data_params
  @clear_apps_data_params
end

#clear_apps_data_status ⇒ Google::Apis::AndroidmanagementV1::ClearAppsDataStatus

Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device. Corresponds to the JSON property clearAppsDataStatus

Returns:



1498
1499
1500
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1498

def clear_apps_data_status
  @clear_apps_data_status
end

#create_time ⇒ String

The timestamp at which the command was created. The timestamp is automatically generated by the server. Corresponds to the JSON property createTime

Returns:

  • (String) 


1504
1505
1506
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1504

def create_time
  @create_time
end

#duration ⇒ String

The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration. Corresponds to the JSON property duration

Returns:

  • (String) 


1511
1512
1513
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1511

def duration
  @duration
end

#error_code ⇒ String

If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller. For reasoning about command errors, prefer fields in the following order (most preferred first): 1. Command-specific fields like clearAppsDataStatus, startLostModeStatus, or similar, if they exist. 2. This field, if set. 3. The generic error field in the Operation that wraps the command. Corresponds to the JSON property errorCode

Returns:

  • (String) 


1521
1522
1523
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1521

def error_code
  @error_code
end

#esim_status ⇒ Google::Apis::AndroidmanagementV1::EsimCommandStatus

Status and error details (if present) of an ADD_ESIM or REMOVE_ESIM command. Corresponds to the JSON property esimStatus

Returns:



1526
1527
1528
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1526

def esim_status
  @esim_status
end

#new_password ⇒ String

For commands of type RESET_PASSWORD, optionally specifies the new password. Note: The new password must be at least 6 characters long if it is numeric in case of Android 14 devices. Else the command will fail with INVALID_VALUE. Corresponds to the JSON property newPassword

Returns:

  • (String) 


1533
1534
1535
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1533

def new_password
  @new_password
end

#remove_esim_params ⇒ Google::Apis::AndroidmanagementV1::RemoveEsimParams

Parameters associated with the REMOVE_ESIM command to remove an eSIM profile from the device. Corresponds to the JSON property removeEsimParams

Returns:



1539
1540
1541
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1539

def remove_esim_params
  @remove_esim_params
end

#request_device_info_params ⇒ Google::Apis::AndroidmanagementV1::RequestDeviceInfoParams

Parameters associated with the REQUEST_DEVICE_INFO command to get device related information. Corresponds to the JSON property requestDeviceInfoParams

Returns:



1545
1546
1547
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1545

def request_device_info_params
  @request_device_info_params
end

#request_device_info_status ⇒ Google::Apis::AndroidmanagementV1::RequestDeviceInfoStatus

Status of the REQUEST_DEVICE_INFO command. Corresponds to the JSON property requestDeviceInfoStatus

Returns:



1550
1551
1552
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1550

def request_device_info_status
  @request_device_info_status
end

#reset_password_flags ⇒ Array<String>

For commands of type RESET_PASSWORD, optionally specifies flags. Corresponds to the JSON property resetPasswordFlags

Returns:

  • (Array<String>) 


1555
1556
1557
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1555

def reset_password_flags
  @reset_password_flags
end

#start_lost_mode_params ⇒ Google::Apis::AndroidmanagementV1::StartLostModeParams

Parameters associated with the START_LOST_MODE command to put the device into lost mode. At least one of the parameters, not including the organization name, must be provided in order for the device to be put into lost mode. Corresponds to the JSON property startLostModeParams

Returns:



1562
1563
1564
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1562

def start_lost_mode_params
  @start_lost_mode_params
end

#start_lost_mode_status ⇒ Google::Apis::AndroidmanagementV1::StartLostModeStatus

Status of the START_LOST_MODE command to put the device into lost mode. Corresponds to the JSON property startLostModeStatus

Returns:



1567
1568
1569
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1567

def start_lost_mode_status
  @start_lost_mode_status
end

#stop_lost_mode_params ⇒ Google::Apis::AndroidmanagementV1::StopLostModeParams

Parameters associated with the STOP_LOST_MODE command to take the device out of lost mode. Corresponds to the JSON property stopLostModeParams

Returns:



1573
1574
1575
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1573

def stop_lost_mode_params
  @stop_lost_mode_params
end

#stop_lost_mode_status ⇒ Google::Apis::AndroidmanagementV1::StopLostModeStatus

Status of the STOP_LOST_MODE command to take the device out of lost mode. Corresponds to the JSON property stopLostModeStatus

Returns:



1578
1579
1580
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1578

def stop_lost_mode_status
  @stop_lost_mode_status
end

#type ⇒ String

The type of the command. Corresponds to the JSON property type

Returns:

  • (String) 


1583
1584
1585
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1583

def type
  @type
end

#user_name ⇒ String

The resource name of the user that owns the device in the form enterprises/ enterpriseId/users/userId. This is automatically generated by the server based on the device the command is sent to. Corresponds to the JSON property userName

Returns:

  • (String) 


1590
1591
1592
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1590

def user_name
  @user_name
end

#wipe_params ⇒ Google::Apis::AndroidmanagementV1::WipeParams

Parameters associated with the WIPE command to wipe the device. Corresponds to the JSON property wipeParams

Returns:



1595
1596
1597
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1595

def wipe_params
  @wipe_params
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1602

def update!(**args)
  @add_esim_params = args[:add_esim_params] if args.key?(:add_esim_params)
  @clear_apps_data_params = args[:clear_apps_data_params] if args.key?(:clear_apps_data_params)
  @clear_apps_data_status = args[:clear_apps_data_status] if args.key?(:clear_apps_data_status)
  @create_time = args[:create_time] if args.key?(:create_time)
  @duration = args[:duration] if args.key?(:duration)
  @error_code = args[:error_code] if args.key?(:error_code)
  @esim_status = args[:esim_status] if args.key?(:esim_status)
  @new_password = args[:new_password] if args.key?(:new_password)
  @remove_esim_params = args[:remove_esim_params] if args.key?(:remove_esim_params)
  @request_device_info_params = args[:request_device_info_params] if args.key?(:request_device_info_params)
  @request_device_info_status = args[:request_device_info_status] if args.key?(:request_device_info_status)
  @reset_password_flags = args[:reset_password_flags] if args.key?(:reset_password_flags)
  @start_lost_mode_params = args[:start_lost_mode_params] if args.key?(:start_lost_mode_params)
  @start_lost_mode_status = args[:start_lost_mode_status] if args.key?(:start_lost_mode_status)
  @stop_lost_mode_params = args[:stop_lost_mode_params] if args.key?(:stop_lost_mode_params)
  @stop_lost_mode_status = args[:stop_lost_mode_status] if args.key?(:stop_lost_mode_status)
  @type = args[:type] if args.key?(:type)
  @user_name = args[:user_name] if args.key?(:user_name)
  @wipe_params = args[:wipe_params] if args.key?(:wipe_params)
end