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.



1161
1162
1163
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1161

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

Instance Attribute Details

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



1087
1088
1089
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1087

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:



1093
1094
1095
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1093

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) 


1099
1100
1101
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1099

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) 


1106
1107
1108
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1106

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. Corresponds to the JSON property errorCode

Returns:

  • (String) 


1112
1113
1114
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1112

def error_code
  @error_code
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) 


1119
1120
1121
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1119

def new_password
  @new_password
end

#reset_password_flags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1124
1125
1126
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1124

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:



1131
1132
1133
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1131

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:



1136
1137
1138
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1136

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:



1142
1143
1144
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1142

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:



1147
1148
1149
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1147

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) 


1152
1153
1154
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1152

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) 


1159
1160
1161
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1159

def user_name
  @user_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1166

def update!(**args)
  @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)
  @new_password = args[:new_password] if args.key?(:new_password)
  @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)
end