Class: Google::Apis::AdminDirectoryV1::ChromeOsDevice

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

Overview

Google Chrome devices run on the Chrome OS. For more information about common API tasks, see the Developer's Guide.

Defined Under Namespace

Classes: ActiveTimeRange, CpuStatusReport, DeviceFile, DiskVolumeReport, LastKnownNetwork, RecentUser, ScreenshotFile, SystemRamFreeReport, TpmVersionInfo

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ChromeOsDevice

Returns a new instance of ChromeOsDevice.



960
961
962
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 960

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

Instance Attribute Details

#active_time_ranges ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::ActiveTimeRange>

List of active time ranges (Read-only). Corresponds to the JSON property activeTimeRanges

Returns:



736
737
738
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 736

def active_time_ranges
  @active_time_ranges
end

#annotated_asset_id ⇒ String

The asset identifier as noted by an administrator or specified during enrollment. Corresponds to the JSON property annotatedAssetId

Returns:

  • (String) 


742
743
744
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 742

def annotated_asset_id
  @annotated_asset_id
end

#annotated_location ⇒ String

The address or location of the device as noted by the administrator. Maximum length is 200 characters. Empty values are allowed. Corresponds to the JSON property annotatedLocation

Returns:

  • (String) 


748
749
750
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 748

def annotated_location
  @annotated_location
end

#annotated_user ⇒ String

The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed. Corresponds to the JSON property annotatedUser

Returns:

  • (String) 


754
755
756
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 754

def annotated_user
  @annotated_user
end

#auto_update_expiration ⇒ Fixnum

(Read-only) The timestamp after which the device will stop receiving Chrome updates or support Corresponds to the JSON property autoUpdateExpiration

Returns:

  • (Fixnum) 


760
761
762
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 760

def auto_update_expiration
  @auto_update_expiration
end

#boot_mode ⇒ String

The boot mode for the device. The possible values are: * Verified: The device is running a valid version of the Chrome OS. * Dev: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the Chromebook developer information. Corresponds to the JSON property bootMode

Returns:

  • (String) 


771
772
773
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 771

def boot_mode
  @boot_mode
end

#cpu_status_reports ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::CpuStatusReport>

Reports of CPU utilization and temperature (Read-only) Corresponds to the JSON property cpuStatusReports

Returns:



776
777
778
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 776

def cpu_status_reports
  @cpu_status_reports
end

#device_files ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::DeviceFile>

List of device files to download (Read-only) Corresponds to the JSON property deviceFiles

Returns:



781
782
783
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 781

def device_files
  @device_files
end

#device_id ⇒ String

The unique ID of the Chrome device. Corresponds to the JSON property deviceId

Returns:

  • (String) 


786
787
788
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 786

def device_id
  @device_id
end

#disk_volume_reports ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::DiskVolumeReport>

Reports of disk space and other info about mounted/connected volumes. Corresponds to the JSON property diskVolumeReports

Returns:



791
792
793
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 791

def disk_volume_reports
  @disk_volume_reports
end

#dock_mac_address ⇒ String

(Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter ( uppercase letters). This is only relevant for some devices. Corresponds to the JSON property dockMacAddress

Returns:

  • (String) 


800
801
802
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 800

def dock_mac_address
  @dock_mac_address
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


805
806
807
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 805

def etag
  @etag
end

#ethernet_mac_address ⇒ String

The device's MAC address on the ethernet network interface. Corresponds to the JSON property ethernetMacAddress

Returns:

  • (String) 


810
811
812
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 810

def ethernet_mac_address
  @ethernet_mac_address
end

#ethernet_mac_address0 ⇒ String

(Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. Corresponds to the JSON property ethernetMacAddress0

Returns:

  • (String) 


818
819
820
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 818

def ethernet_mac_address0
  @ethernet_mac_address0
end

#firmware_version ⇒ String

The Chrome device's firmware version. Corresponds to the JSON property firmwareVersion

Returns:

  • (String) 


823
824
825
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 823

def firmware_version
  @firmware_version
end

#kind ⇒ String

The type of resource. For the Chromeosdevices resource, the value is admin# directory#chromeosdevice. Corresponds to the JSON property kind

Returns:

  • (String) 


829
830
831
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 829

def kind
  @kind
end

#last_enrollment_time ⇒ DateTime

Date and time the device was last enrolled (Read-only) Corresponds to the JSON property lastEnrollmentTime

Returns:

  • (DateTime) 


834
835
836
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 834

def last_enrollment_time
  @last_enrollment_time
end

#last_known_network ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::LastKnownNetwork>

Contains last known network (Read-only) Corresponds to the JSON property lastKnownNetwork

Returns:



839
840
841
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 839

def last_known_network
  @last_known_network
end

#last_sync ⇒ DateTime

Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) Corresponds to the JSON property lastSync

Returns:

  • (DateTime) 


845
846
847
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 845

def last_sync
  @last_sync
end

#mac_address ⇒ String

The device's wireless MAC address. If the device does not have this information, it is not included in the response. Corresponds to the JSON property macAddress

Returns:

  • (String) 


851
852
853
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 851

def mac_address
  @mac_address
end

#manufacture_date ⇒ String

(Read-only) The date the device was manufactured in yyyy-mm-dd format. Corresponds to the JSON property manufactureDate

Returns:

  • (String) 


856
857
858
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 856

def manufacture_date
  @manufacture_date
end

#meid ⇒ String

The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the Developer's Guide. Corresponds to the JSON property meid

Returns:

  • (String) 


867
868
869
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 867

def meid
  @meid
end

#model ⇒ String

The device's model information. If the device does not have this information, this property is not included in the response. Corresponds to the JSON property model

Returns:

  • (String) 


873
874
875
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 873

def model
  @model
end

#notes ⇒ String

Notes about this device added by the administrator. This property can be searched with the list method's query parameter. Maximum length is 500 characters. Empty values are allowed. Corresponds to the JSON property notes

Returns:

  • (String) 


881
882
883
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 881

def notes
  @notes
end

#order_number ⇒ String

The device's order number. Only devices directly purchased from Google have an order number. Corresponds to the JSON property orderNumber

Returns:

  • (String) 


887
888
889
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 887

def order_number
  @order_number
end

#org_unit_path ⇒ String

The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, /. This property can be updated using the API. For more information about how to create an organizational structure for your device, see the administration help center. Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


898
899
900
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 898

def org_unit_path
  @org_unit_path
end

#os_version ⇒ String

The Chrome device's operating system version. Corresponds to the JSON property osVersion

Returns:

  • (String) 


903
904
905
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 903

def os_version
  @os_version
end

#platform_version ⇒ String

The Chrome device's platform version. Corresponds to the JSON property platformVersion

Returns:

  • (String) 


908
909
910
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 908

def platform_version
  @platform_version
end

#recent_users ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::RecentUser>

List of recent device users, in descending order, by last login time. Corresponds to the JSON property recentUsers

Returns:



913
914
915
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 913

def recent_users
  @recent_users
end

#screenshot_files ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::ScreenshotFile>

List of screenshot files to download. Type is always "SCREENSHOT_FILE". (Read- only) Corresponds to the JSON property screenshotFiles

Returns:



919
920
921
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 919

def screenshot_files
  @screenshot_files
end

#serial_number ⇒ String

The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's Serial Number in the Chrome OS Devices tab. Corresponds to the JSON property serialNumber

Returns:

  • (String) 


926
927
928
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 926

def serial_number
  @serial_number
end

#status ⇒ String

The status of the device. Corresponds to the JSON property status

Returns:

  • (String) 


931
932
933
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 931

def status
  @status
end

#support_end_date ⇒ DateTime

Final date the device will be supported (Read-only) Corresponds to the JSON property supportEndDate

Returns:

  • (DateTime) 


936
937
938
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 936

def support_end_date
  @support_end_date
end

#system_ram_free_reports ⇒ Array<Google::Apis::AdminDirectoryV1::ChromeOsDevice::SystemRamFreeReport>

Reports of amounts of available RAM memory (Read-only) Corresponds to the JSON property systemRamFreeReports

Returns:



941
942
943
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 941

def system_ram_free_reports
  @system_ram_free_reports
end

#system_ram_total ⇒ Fixnum

Total RAM on the device in bytes Corresponds to the JSON property systemRamTotal

Returns:

  • (Fixnum) 


946
947
948
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 946

def system_ram_total
  @system_ram_total
end

#tpm_version_info ⇒ Google::Apis::AdminDirectoryV1::ChromeOsDevice::TpmVersionInfo

Trusted Platform Module (TPM) (Read-only) Corresponds to the JSON property tpmVersionInfo

Returns:



951
952
953
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 951

def tpm_version_info
  @tpm_version_info
end

#will_auto_renew ⇒ Boolean Also known as: will_auto_renew?

Determines if the device will auto renew its support after the support end date. This is a read-only property. Corresponds to the JSON property willAutoRenew

Returns:

  • (Boolean) 


957
958
959
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 957

def will_auto_renew
  @will_auto_renew
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 965

def update!(**args)
  @active_time_ranges = args[:active_time_ranges] if args.key?(:active_time_ranges)
  @annotated_asset_id = args[:annotated_asset_id] if args.key?(:annotated_asset_id)
  @annotated_location = args[:annotated_location] if args.key?(:annotated_location)
  @annotated_user = args[:annotated_user] if args.key?(:annotated_user)
  @auto_update_expiration = args[:auto_update_expiration] if args.key?(:auto_update_expiration)
  @boot_mode = args[:boot_mode] if args.key?(:boot_mode)
  @cpu_status_reports = args[:cpu_status_reports] if args.key?(:cpu_status_reports)
  @device_files = args[:device_files] if args.key?(:device_files)
  @device_id = args[:device_id] if args.key?(:device_id)
  @disk_volume_reports = args[:disk_volume_reports] if args.key?(:disk_volume_reports)
  @dock_mac_address = args[:dock_mac_address] if args.key?(:dock_mac_address)
  @etag = args[:etag] if args.key?(:etag)
  @ethernet_mac_address = args[:ethernet_mac_address] if args.key?(:ethernet_mac_address)
  @ethernet_mac_address0 = args[:ethernet_mac_address0] if args.key?(:ethernet_mac_address0)
  @firmware_version = args[:firmware_version] if args.key?(:firmware_version)
  @kind = args[:kind] if args.key?(:kind)
  @last_enrollment_time = args[:last_enrollment_time] if args.key?(:last_enrollment_time)
  @last_known_network = args[:last_known_network] if args.key?(:last_known_network)
  @last_sync = args[:last_sync] if args.key?(:last_sync)
  @mac_address = args[:mac_address] if args.key?(:mac_address)
  @manufacture_date = args[:manufacture_date] if args.key?(:manufacture_date)
  @meid = args[:meid] if args.key?(:meid)
  @model = args[:model] if args.key?(:model)
  @notes = args[:notes] if args.key?(:notes)
  @order_number = args[:order_number] if args.key?(:order_number)
  @org_unit_path = args[:org_unit_path] if args.key?(:org_unit_path)
  @os_version = args[:os_version] if args.key?(:os_version)
  @platform_version = args[:platform_version] if args.key?(:platform_version)
  @recent_users = args[:recent_users] if args.key?(:recent_users)
  @screenshot_files = args[:screenshot_files] if args.key?(:screenshot_files)
  @serial_number = args[:serial_number] if args.key?(:serial_number)
  @status = args[:status] if args.key?(:status)
  @support_end_date = args[:support_end_date] if args.key?(:support_end_date)
  @system_ram_free_reports = args[:system_ram_free_reports] if args.key?(:system_ram_free_reports)
  @system_ram_total = args[:system_ram_total] if args.key?(:system_ram_total)
  @tpm_version_info = args[:tpm_version_info] if args.key?(:tpm_version_info)
  @will_auto_renew = args[:will_auto_renew] if args.key?(:will_auto_renew)
end