Class: Google::Apis::AndroiddeviceprovisioningV1::Configuration

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

Overview

A configuration collects the provisioning options for Android devices. Each configuration combines the following:

  • The EMM device policy controller (DPC) installed on the devices.
  • EMM policies enforced on the devices.
  • Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Configuration

Returns a new instance of Configuration



254
255
256
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 254

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

Instance Attribute Details

#company_name ⇒ String

Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning. Corresponds to the JSON property companyName

Returns:

  • (String) 


188
189
190
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 188

def company_name
  @company_name
end

#configuration_id ⇒ Fixnum

Output only. The ID of the configuration. Assigned by the server. Corresponds to the JSON property configurationId

Returns:

  • (Fixnum) 


193
194
195
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 193

def configuration_id
  @configuration_id
end

#configuration_name ⇒ String

Required. A short name that describes the configuration's purpose. For example, Sales team or Temporary employees. The zero-touch enrollment portal displays this name to IT admins. Corresponds to the JSON property configurationName

Returns:

  • (String) 


200
201
202
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 200

def configuration_name
  @configuration_name
end

#contact_email ⇒ String

Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input. Corresponds to the JSON property contactEmail

Returns:

  • (String) 


207
208
209
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 207

def contact_email
  @contact_email
end

#contact_phone ⇒ String

Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses. Corresponds to the JSON property contactPhone

Returns:

  • (String) 


215
216
217
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 215

def contact_phone
  @contact_phone
end

#custom_message ⇒ String

A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned. Corresponds to the JSON property customMessage

Returns:

  • (String) 


222
223
224
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 222

def custom_message
  @custom_message
end

#dpc_extras ⇒ String

The JSON-formatted EMM provisioning extras that are passed to the DPC. Corresponds to the JSON property dpcExtras

Returns:

  • (String) 


227
228
229
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 227

def dpc_extras
  @dpc_extras
end

#dpc_resource_path ⇒ String

Required. The resource name of the selected DPC (device policy controller) in the format customers/[CUSTOMER_ID]/dpcs/*. To list the supported DPCs, call customers.dpcs.list. Corresponds to the JSON property dpcResourcePath

Returns:

  • (String) 


235
236
237
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 235

def dpc_resource_path
  @dpc_resource_path
end

#is_default ⇒ Boolean Also known as: is_default?

Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to true, changes the previous default configuration's isDefault value to false. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


244
245
246
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 244

def is_default
  @is_default
end

#name ⇒ String

Output only. The API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Assigned by the server. Corresponds to the JSON property name

Returns:

  • (String) 


252
253
254
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 252

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/classes.rb', line 259

def update!(**args)
  @company_name = args[:company_name] if args.key?(:company_name)
  @configuration_id = args[:configuration_id] if args.key?(:configuration_id)
  @configuration_name = args[:configuration_name] if args.key?(:configuration_name)
  @contact_email = args[:contact_email] if args.key?(:contact_email)
  @contact_phone = args[:contact_phone] if args.key?(:contact_phone)
  @custom_message = args[:custom_message] if args.key?(:custom_message)
  @dpc_extras = args[:dpc_extras] if args.key?(:dpc_extras)
  @dpc_resource_path = args[:dpc_resource_path] if args.key?(:dpc_resource_path)
  @is_default = args[:is_default] if args.key?(:is_default)
  @name = args[:name] if args.key?(:name)
end