Configuration (Android Device Provisioning Partner API v1-rev20250331-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.androiddeviceprovisioning.v1.model.Configuration

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Configuration
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Android Device Provisioning Partner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configuration`	`clone()`
`String`	`getCompanyName()` Required.
`Long`	`getConfigurationId()` Output only.
`String`	`getConfigurationName()` Required.
`String`	`getContactEmail()` Required.
`String`	`getContactPhone()` Required.
`String`	`getCustomMessage()` 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.
`String`	`getDpcExtras()` The JSON-formatted EMM provisioning extras that are passed to the DPC.
`String`	`getDpcResourcePath()` Required.
`String`	`getForcedResetTime()` Optional.
`Boolean`	`getIsDefault()` Required.
`String`	`getName()` Output only.
`Configuration`	`set(String fieldName, Object value)`
`Configuration`	`setCompanyName(String companyName)` Required.
`Configuration`	`setConfigurationId(Long configurationId)` Output only.
`Configuration`	`setConfigurationName(String configurationName)` Required.
`Configuration`	`setContactEmail(String contactEmail)` Required.
`Configuration`	`setContactPhone(String contactPhone)` Required.
`Configuration`	`setCustomMessage(String customMessage)` 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.
`Configuration`	`setDpcExtras(String dpcExtras)` The JSON-formatted EMM provisioning extras that are passed to the DPC.
`Configuration`	`setDpcResourcePath(String dpcResourcePath)` Required.
`Configuration`	`setForcedResetTime(String forcedResetTime)` Optional.
`Configuration`	`setIsDefault(Boolean isDefault)` Required.
`Configuration`	`setName(String name)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - getCompanyName
```
public String getCompanyName()
```
    Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.
    
    Returns:
    
    value or null for none
  - setCompanyName
```
public Configuration setCompanyName(String companyName)
```
    Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.
    
    Parameters:
    
    companyName - companyName or null for none
  - getConfigurationId
```
public Long getConfigurationId()
```
    Output only. The ID of the configuration. Assigned by the server.
    
    Returns:
    
    value or null for none
  - setConfigurationId
```
public Configuration setConfigurationId(Long configurationId)
```
    Output only. The ID of the configuration. Assigned by the server.
    
    Parameters:
    
    configurationId - configurationId or null for none
  - getConfigurationName
```
public String getConfigurationName()
```
    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.
    
    Returns:
    
    value or null for none
  - setConfigurationName
```
public Configuration setConfigurationName(String configurationName)
```
    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.
    
    Parameters:
    
    configurationName - configurationName or null for none
  - getContactEmail
```
public String getContactEmail()
```
    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.
    
    Returns:
    
    value or null for none
  - setContactEmail
```
public Configuration setContactEmail(String contactEmail)
```
    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.
    
    Parameters:
    
    contactEmail - contactEmail or null for none
  - getContactPhone
```
public String getContactPhone()
```
    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.
    
    Returns:
    
    value or null for none
  - setContactPhone
```
public Configuration setContactPhone(String contactPhone)
```
    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.
    
    Parameters:
    
    contactPhone - contactPhone or null for none
  - getCustomMessage
```
public String getCustomMessage()
```
    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.
    
    Returns:
    
    value or null for none
  - setCustomMessage
```
public Configuration setCustomMessage(String customMessage)
```
    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.
    
    Parameters:
    
    customMessage - customMessage or null for none
  - getDpcExtras
```
public String getDpcExtras()
```
    The JSON-formatted EMM provisioning extras that are passed to the DPC.
    
    Returns:
    
    value or null for none
  - setDpcExtras
```
public Configuration setDpcExtras(String dpcExtras)
```
    The JSON-formatted EMM provisioning extras that are passed to the DPC.
    
    Parameters:
    
    dpcExtras - dpcExtras or null for none
  - getDpcResourcePath
```
public String getDpcResourcePath()
```
    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`.
    
    Returns:
    
    value or null for none
  - setDpcResourcePath
```
public Configuration setDpcResourcePath(String dpcResourcePath)
```
    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`.
    
    Parameters:
    
    dpcResourcePath - dpcResourcePath or null for none
  - getForcedResetTime
```
public String getForcedResetTime()
```
    Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset.
    
    Returns:
    
    value or null for none
  - setForcedResetTime
```
public Configuration setForcedResetTime(String forcedResetTime)
```
    Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset.
    
    Parameters:
    
    forcedResetTime - forcedResetTime or null for none
  - getIsDefault
```
public Boolean getIsDefault()
```
    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`.
    
    Returns:
    
    value or null for none
  - setIsDefault
```
public Configuration setIsDefault(Boolean isDefault)
```
    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`.
    
    Parameters:
    
    isDefault - isDefault or null for none
  - getName
```
public String getName()
```
    Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
    
    Returns:
    
    value or null for none
  - setName
```
public Configuration setName(String name)
```
    Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.
    
    Parameters:
    
    name - name or null for none
  - set
```
public Configuration set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Configuration clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Configuration

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Configuration

Method Detail

getCompanyName

setCompanyName

getConfigurationId

setConfigurationId

getConfigurationName

setConfigurationName

getContactEmail

setContactEmail

getContactPhone

setContactPhone

getCustomMessage

setCustomMessage

getDpcExtras

setDpcExtras

getDpcResourcePath

setDpcResourcePath

getForcedResetTime

setForcedResetTime

getIsDefault

setIsDefault

getName

setName

set

clone