generated/google/apis/androiddeviceprovisioning_v1/classes.rb in google-api-client-0.17.2 vs generated/google/apis/androiddeviceprovisioning_v1/classes.rb in google-api-client-0.17.3

- old
+ new

@@ -29,11 +29,12 @@ # The customer to claim for. # Corresponds to the JSON property `customerId` # @return [Fixnum] attr_accessor :customer_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier # The section to claim. @@ -165,41 +166,49 @@ def update!(**args) @customer = args[:customer] if args.key?(:customer) end end - # An Android device. + # An Android device registered for zero-touch enrollment. class Device include Google::Apis::Core::Hashable - # Claims. + # Output only. The provisioning claims for a device. Devices claimed for + # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. + # Call + # `partners.devices.unclaim` + # or + # `partners.devices.unclaimAsync` + # to remove the device from zero-touch enrollment. # Corresponds to the JSON property `claims` # @return [Array<Google::Apis::AndroiddeviceprovisioningV1::DeviceClaim>] attr_accessor :claims - # The resource name of the configuration. - # Only set for customers. + # Not available to resellers. # Corresponds to the JSON property `configuration` # @return [String] attr_accessor :configuration - # Device ID. + # Output only. The ID of the device. Assigned by the server. # Corresponds to the JSON property `deviceId` # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata - # Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + # Output only. The API resource name in the format + # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) @@ -215,20 +224,23 @@ @device_metadata = args[:device_metadata] if args.key?(:device_metadata) @name = args[:name] if args.key?(:name) end end - # Information about a device claimed for a partner. + # A record of a device claimed by a reseller for a customer. Devices claimed + # for zero-touch enrollment have a claim with the type + # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read + # [Claim devices for customers](/zero-touch/guides/how-it-works#claim). class DeviceClaim include Google::Apis::Core::Hashable - # Owner ID. + # The ID of the Customer that purchased the device. # Corresponds to the JSON property `ownerCompanyId` # @return [Fixnum] attr_accessor :owner_company_id - # Section type of the device claim. + # Output only. The type of claim made on the device. # Corresponds to the JSON property `sectionType` # @return [String] attr_accessor :section_type def initialize(**args) @@ -240,32 +252,34 @@ @owner_company_id = args[:owner_company_id] if args.key?(:owner_company_id) @section_type = args[:section_type] if args.key?(:section_type) end end - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). class DeviceIdentifier include Google::Apis::Core::Hashable - # IMEI number. + # The device’s IMEI number. Validated on input. # Corresponds to the JSON property `imei` # @return [String] attr_accessor :imei - # Manufacturer name to match `android.os.Build.MANUFACTURER` (required). - # Allowed values listed in - # [manufacturer names](/zero-touch/resources/manufacturer-names). + # Required. The device manufacturer’s name. Matches the device's built-in + # value returned from `android.os.Build.MANUFACTURER`. Allowed values are + # listed in [manufacturer names](/zero-touch/resources/manufacturer-names). # Corresponds to the JSON property `manufacturer` # @return [String] attr_accessor :manufacturer - # MEID number. + # The device’s MEID number. # Corresponds to the JSON property `meid` # @return [String] attr_accessor :meid - # Serial number (optional). + # The manufacturer's serial number for the device. This value might not be + # unique. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number def initialize(**args) @@ -279,15 +293,16 @@ @meid = args[:meid] if args.key?(:meid) @serial_number = args[:serial_number] if args.key?(:serial_number) end end - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). class DeviceMetadata include Google::Apis::Core::Hashable - # Metadata entries + # Metadata entries recorded as key-value pairs. # Corresponds to the JSON property `entries` # @return [Hash<String,String>] attr_accessor :entries def initialize(**args) @@ -378,11 +393,12 @@ # Request to find devices. class FindDevicesByDeviceIdentifierRequest include Google::Apis::Core::Hashable - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier # Number of devices to show. @@ -646,16 +662,18 @@ # Customer ID to claim for. # Corresponds to the JSON property `customerId` # @return [Fixnum] attr_accessor :customer_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata # Section type to claim. @@ -683,11 +701,12 @@ # Device ID of the device. # Corresponds to the JSON property `deviceId` # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier # Section type to unclaim. @@ -823,11 +842,12 @@ # The device ID returned by `ClaimDevice`. # Corresponds to the JSON property `deviceId` # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier # The section type to unclaim for. @@ -887,11 +907,12 @@ # Request to set metadata for a device. class UpdateDeviceMetadataRequest include Google::Apis::Core::Hashable - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata def initialize(**args) @@ -911,15 +932,17 @@ # Device ID of the device. # Corresponds to the JSON property `deviceId` # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata def initialize(**args)