| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.AndroidDeviceProvisioning.Types
Contents
- Service Configuration
- UpdateMetadataArguments
- Status
- PartnerClaim
- CustomerUnclaimDeviceRequest
- PerDeviceStatusInBatchStatus
- FindDevicesByOwnerRequestSectionType
- FindDevicesByDeviceIdentifierRequest
- FindDevicesByOwnerResponse
- DeviceMetadataEntries
- PartnerUnclaim
- Dpc
- ListVendorCustomersResponse
- OperationPerDevice
- Operation
- Empty
- PartnerClaimSectionType
- PerDeviceStatusInBatch
- ClaimDevicesRequest
- Device
- ClaimDeviceRequest
- DeviceReference
- CustomerRemoveConfigurationRequest
- DeviceIdentifier
- UnclaimDevicesRequest
- StatusDetailsItem
- ListVendorsResponse
- CustomerListConfigurationsResponse
- PartnerUnclaimSectionType
- CustomerApplyConfigurationRequest
- Company
- Xgafv
- ClaimDeviceRequestSectionType
- CustomerListCustomersResponse
- DeviceClaim
- UpdateDeviceMetadataRequest
- DeviceMetadata
- FindDevicesByOwnerRequest
- FindDevicesByDeviceIdentifierResponse
- UnclaimDeviceRequest
- DevicesLongRunningOperationResponse
- Configuration
- OperationMetadata
- DeviceClaimSectionType
- ListCustomersResponse
- DevicesLongRunningOperationMetadata
- OperationResponse
- CompanyTermsStatus
- CustomerListDevicesResponse
- UpdateDeviceMetadataInBatchRequest
- UnclaimDeviceRequestSectionType
- CustomerListDpcsResponse
- ClaimDeviceResponse
- CreateCustomerRequest
- DevicesLongRunningOperationMetadataProcessingStatus
Description
Synopsis
- androidDeviceProvisioningService :: ServiceConfig
- data UpdateMetadataArguments
- updateMetadataArguments :: UpdateMetadataArguments
- umaDeviceIdentifier :: Lens' UpdateMetadataArguments (Maybe DeviceIdentifier)
- umaDeviceId :: Lens' UpdateMetadataArguments (Maybe Int64)
- umaDeviceMetadata :: Lens' UpdateMetadataArguments (Maybe DeviceMetadata)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data PartnerClaim
- partnerClaim :: PartnerClaim
- pcDeviceIdentifier :: Lens' PartnerClaim (Maybe DeviceIdentifier)
- pcSectionType :: Lens' PartnerClaim (Maybe PartnerClaimSectionType)
- pcCustomerId :: Lens' PartnerClaim (Maybe Int64)
- pcDeviceMetadata :: Lens' PartnerClaim (Maybe DeviceMetadata)
- data CustomerUnclaimDeviceRequest
- customerUnclaimDeviceRequest :: CustomerUnclaimDeviceRequest
- cudrDevice :: Lens' CustomerUnclaimDeviceRequest (Maybe DeviceReference)
- data PerDeviceStatusInBatchStatus
- data FindDevicesByOwnerRequestSectionType
- data FindDevicesByDeviceIdentifierRequest
- findDevicesByDeviceIdentifierRequest :: FindDevicesByDeviceIdentifierRequest
- fdbdirDeviceIdentifier :: Lens' FindDevicesByDeviceIdentifierRequest (Maybe DeviceIdentifier)
- fdbdirLimit :: Lens' FindDevicesByDeviceIdentifierRequest (Maybe Int64)
- fdbdirPageToken :: Lens' FindDevicesByDeviceIdentifierRequest (Maybe Text)
- data FindDevicesByOwnerResponse
- findDevicesByOwnerResponse :: FindDevicesByOwnerResponse
- fdborNextPageToken :: Lens' FindDevicesByOwnerResponse (Maybe Text)
- fdborTotalSize :: Lens' FindDevicesByOwnerResponse (Maybe Int32)
- fdborDevices :: Lens' FindDevicesByOwnerResponse [Device]
- data DeviceMetadataEntries
- deviceMetadataEntries :: HashMap Text Text -> DeviceMetadataEntries
- dmeAddtional :: Lens' DeviceMetadataEntries (HashMap Text Text)
- data PartnerUnclaim
- partnerUnclaim :: PartnerUnclaim
- puDeviceIdentifier :: Lens' PartnerUnclaim (Maybe DeviceIdentifier)
- puSectionType :: Lens' PartnerUnclaim (Maybe PartnerUnclaimSectionType)
- puDeviceId :: Lens' PartnerUnclaim (Maybe Int64)
- data Dpc
- dpc :: Dpc
- dPackageName :: Lens' Dpc (Maybe Text)
- dName :: Lens' Dpc (Maybe Text)
- dDpcName :: Lens' Dpc (Maybe Text)
- data ListVendorCustomersResponse
- listVendorCustomersResponse :: ListVendorCustomersResponse
- lvcrCustomers :: Lens' ListVendorCustomersResponse [Company]
- lvcrNextPageToken :: Lens' ListVendorCustomersResponse (Maybe Text)
- lvcrTotalSize :: Lens' ListVendorCustomersResponse (Maybe Int32)
- data OperationPerDevice
- operationPerDevice :: OperationPerDevice
- opdUpdateMetadata :: Lens' OperationPerDevice (Maybe UpdateMetadataArguments)
- opdResult :: Lens' OperationPerDevice (Maybe PerDeviceStatusInBatch)
- opdClaim :: Lens' OperationPerDevice (Maybe PartnerClaim)
- opdUnclaim :: Lens' OperationPerDevice (Maybe PartnerUnclaim)
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data Empty
- empty :: Empty
- data PartnerClaimSectionType
- data PerDeviceStatusInBatch
- perDeviceStatusInBatch :: PerDeviceStatusInBatch
- pdsibStatus :: Lens' PerDeviceStatusInBatch (Maybe PerDeviceStatusInBatchStatus)
- pdsibErrorIdentifier :: Lens' PerDeviceStatusInBatch (Maybe Text)
- pdsibDeviceId :: Lens' PerDeviceStatusInBatch (Maybe Int64)
- pdsibErrorMessage :: Lens' PerDeviceStatusInBatch (Maybe Text)
- data ClaimDevicesRequest
- claimDevicesRequest :: ClaimDevicesRequest
- cdrClaims :: Lens' ClaimDevicesRequest [PartnerClaim]
- data Device
- device :: Device
- devDeviceIdentifier :: Lens' Device (Maybe DeviceIdentifier)
- devClaims :: Lens' Device [DeviceClaim]
- devName :: Lens' Device (Maybe Text)
- devDeviceId :: Lens' Device (Maybe Int64)
- devDeviceMetadata :: Lens' Device (Maybe DeviceMetadata)
- devConfiguration :: Lens' Device (Maybe Text)
- data ClaimDeviceRequest
- claimDeviceRequest :: ClaimDeviceRequest
- cdrDeviceIdentifier :: Lens' ClaimDeviceRequest (Maybe DeviceIdentifier)
- cdrSectionType :: Lens' ClaimDeviceRequest (Maybe ClaimDeviceRequestSectionType)
- cdrCustomerId :: Lens' ClaimDeviceRequest (Maybe Int64)
- cdrDeviceMetadata :: Lens' ClaimDeviceRequest (Maybe DeviceMetadata)
- data DeviceReference
- deviceReference :: DeviceReference
- drDeviceIdentifier :: Lens' DeviceReference (Maybe DeviceIdentifier)
- drDeviceId :: Lens' DeviceReference (Maybe Int64)
- data CustomerRemoveConfigurationRequest
- customerRemoveConfigurationRequest :: CustomerRemoveConfigurationRequest
- crcrDevice :: Lens' CustomerRemoveConfigurationRequest (Maybe DeviceReference)
- data DeviceIdentifier
- deviceIdentifier :: DeviceIdentifier
- diManufacturer :: Lens' DeviceIdentifier (Maybe Text)
- diModel :: Lens' DeviceIdentifier (Maybe Text)
- diMeid :: Lens' DeviceIdentifier (Maybe Text)
- diImei :: Lens' DeviceIdentifier (Maybe Text)
- diSerialNumber :: Lens' DeviceIdentifier (Maybe Text)
- data UnclaimDevicesRequest
- unclaimDevicesRequest :: UnclaimDevicesRequest
- udrUnclaims :: Lens' UnclaimDevicesRequest [PartnerUnclaim]
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data ListVendorsResponse
- listVendorsResponse :: ListVendorsResponse
- lvrNextPageToken :: Lens' ListVendorsResponse (Maybe Text)
- lvrTotalSize :: Lens' ListVendorsResponse (Maybe Int32)
- lvrVendors :: Lens' ListVendorsResponse [Company]
- data CustomerListConfigurationsResponse
- customerListConfigurationsResponse :: CustomerListConfigurationsResponse
- clcrConfigurations :: Lens' CustomerListConfigurationsResponse [Configuration]
- data PartnerUnclaimSectionType
- data CustomerApplyConfigurationRequest
- customerApplyConfigurationRequest :: CustomerApplyConfigurationRequest
- cacrDevice :: Lens' CustomerApplyConfigurationRequest (Maybe DeviceReference)
- cacrConfiguration :: Lens' CustomerApplyConfigurationRequest (Maybe Text)
- data Company
- company :: Company
- cCompanyId :: Lens' Company (Maybe Int64)
- cCompanyName :: Lens' Company (Maybe Text)
- cOwnerEmails :: Lens' Company [Text]
- cTermsStatus :: Lens' Company (Maybe CompanyTermsStatus)
- cName :: Lens' Company (Maybe Text)
- cAdminEmails :: Lens' Company [Text]
- data Xgafv
- data ClaimDeviceRequestSectionType
- data CustomerListCustomersResponse
- customerListCustomersResponse :: CustomerListCustomersResponse
- clcrCustomers :: Lens' CustomerListCustomersResponse [Company]
- clcrNextPageToken :: Lens' CustomerListCustomersResponse (Maybe Text)
- data DeviceClaim
- deviceClaim :: DeviceClaim
- dcSectionType :: Lens' DeviceClaim (Maybe DeviceClaimSectionType)
- dcOwnerCompanyId :: Lens' DeviceClaim (Maybe Int64)
- dcResellerId :: Lens' DeviceClaim (Maybe Int64)
- data UpdateDeviceMetadataRequest
- updateDeviceMetadataRequest :: UpdateDeviceMetadataRequest
- udmrDeviceMetadata :: Lens' UpdateDeviceMetadataRequest (Maybe DeviceMetadata)
- data DeviceMetadata
- deviceMetadata :: DeviceMetadata
- dmEntries :: Lens' DeviceMetadata (Maybe DeviceMetadataEntries)
- data FindDevicesByOwnerRequest
- findDevicesByOwnerRequest :: FindDevicesByOwnerRequest
- fdborSectionType :: Lens' FindDevicesByOwnerRequest (Maybe FindDevicesByOwnerRequestSectionType)
- fdborCustomerId :: Lens' FindDevicesByOwnerRequest [Int64]
- fdborLimit :: Lens' FindDevicesByOwnerRequest (Maybe Int64)
- fdborPageToken :: Lens' FindDevicesByOwnerRequest (Maybe Text)
- data FindDevicesByDeviceIdentifierResponse
- findDevicesByDeviceIdentifierResponse :: FindDevicesByDeviceIdentifierResponse
- fdbdirNextPageToken :: Lens' FindDevicesByDeviceIdentifierResponse (Maybe Text)
- fdbdirTotalSize :: Lens' FindDevicesByDeviceIdentifierResponse (Maybe Int32)
- fdbdirDevices :: Lens' FindDevicesByDeviceIdentifierResponse [Device]
- data UnclaimDeviceRequest
- unclaimDeviceRequest :: UnclaimDeviceRequest
- udrDeviceIdentifier :: Lens' UnclaimDeviceRequest (Maybe DeviceIdentifier)
- udrSectionType :: Lens' UnclaimDeviceRequest (Maybe UnclaimDeviceRequestSectionType)
- udrDeviceId :: Lens' UnclaimDeviceRequest (Maybe Int64)
- data DevicesLongRunningOperationResponse
- devicesLongRunningOperationResponse :: DevicesLongRunningOperationResponse
- dlrorSuccessCount :: Lens' DevicesLongRunningOperationResponse (Maybe Int32)
- dlrorPerDeviceStatus :: Lens' DevicesLongRunningOperationResponse [OperationPerDevice]
- data Configuration
- configuration :: Configuration
- conContactPhone :: Lens' Configuration (Maybe Text)
- conContactEmail :: Lens' Configuration (Maybe Text)
- conConfigurationName :: Lens' Configuration (Maybe Text)
- conConfigurationId :: Lens' Configuration (Maybe Int64)
- conCustomMessage :: Lens' Configuration (Maybe Text)
- conCompanyName :: Lens' Configuration (Maybe Text)
- conDpcExtras :: Lens' Configuration (Maybe Text)
- conName :: Lens' Configuration (Maybe Text)
- conDpcResourcePath :: Lens' Configuration (Maybe Text)
- conIsDefault :: Lens' Configuration (Maybe Bool)
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data DeviceClaimSectionType
- data ListCustomersResponse
- listCustomersResponse :: ListCustomersResponse
- lcrCustomers :: Lens' ListCustomersResponse [Company]
- lcrNextPageToken :: Lens' ListCustomersResponse (Maybe Text)
- lcrTotalSize :: Lens' ListCustomersResponse (Maybe Int32)
- data DevicesLongRunningOperationMetadata
- devicesLongRunningOperationMetadata :: DevicesLongRunningOperationMetadata
- dlromProgress :: Lens' DevicesLongRunningOperationMetadata (Maybe Int32)
- dlromDevicesCount :: Lens' DevicesLongRunningOperationMetadata (Maybe Int32)
- dlromProcessingStatus :: Lens' DevicesLongRunningOperationMetadata (Maybe DevicesLongRunningOperationMetadataProcessingStatus)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data CompanyTermsStatus
- data CustomerListDevicesResponse
- customerListDevicesResponse :: CustomerListDevicesResponse
- cldrNextPageToken :: Lens' CustomerListDevicesResponse (Maybe Text)
- cldrDevices :: Lens' CustomerListDevicesResponse [Device]
- data UpdateDeviceMetadataInBatchRequest
- updateDeviceMetadataInBatchRequest :: UpdateDeviceMetadataInBatchRequest
- udmibrUpdates :: Lens' UpdateDeviceMetadataInBatchRequest [UpdateMetadataArguments]
- data UnclaimDeviceRequestSectionType
- data CustomerListDpcsResponse
- customerListDpcsResponse :: CustomerListDpcsResponse
- cldrDpcs :: Lens' CustomerListDpcsResponse [Dpc]
- data ClaimDeviceResponse
- claimDeviceResponse :: ClaimDeviceResponse
- cdrDeviceName :: Lens' ClaimDeviceResponse (Maybe Text)
- cdrDeviceId :: Lens' ClaimDeviceResponse (Maybe Int64)
- data CreateCustomerRequest
- createCustomerRequest :: CreateCustomerRequest
- ccrCustomer :: Lens' CreateCustomerRequest (Maybe Company)
- data DevicesLongRunningOperationMetadataProcessingStatus
Service Configuration
androidDeviceProvisioningService :: ServiceConfig Source #
Default request referring to version v1 of the Android Device Provisioning Partner API. This contains the host and root path used as a starting point for constructing service requests.
UpdateMetadataArguments
data UpdateMetadataArguments Source #
Identifies metdata updates to one device.
See: updateMetadataArguments smart constructor.
Instances
updateMetadataArguments :: UpdateMetadataArguments Source #
Creates a value of UpdateMetadataArguments with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
umaDeviceIdentifier :: Lens' UpdateMetadataArguments (Maybe DeviceIdentifier) Source #
Device identifier.
umaDeviceId :: Lens' UpdateMetadataArguments (Maybe Int64) Source #
Device ID of the device.
umaDeviceMetadata :: Lens' UpdateMetadataArguments (Maybe DeviceMetadata) Source #
Required. The metadata to update.
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status smart constructor.
Instances
| Eq Status Source # | |
| Data Status Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
| Show Status Source # | |
| Generic Status Source # | |
| ToJSON Status Source # | |
| FromJSON Status Source # | |
| type Rep Status Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.AndroidDeviceProvisioning.Types.Product" "gogol-androiddeviceprovisioning-0.4.0-8GRqRwv1LfcIpEsrUb285r" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
PartnerClaim
data PartnerClaim Source #
Identifies one claim request.
See: partnerClaim smart constructor.
Instances
partnerClaim :: PartnerClaim Source #
Creates a value of PartnerClaim with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcDeviceIdentifier :: Lens' PartnerClaim (Maybe DeviceIdentifier) Source #
Required. Device identifier of the device.
pcSectionType :: Lens' PartnerClaim (Maybe PartnerClaimSectionType) Source #
Required. The section type of the device's provisioning record.
pcCustomerId :: Lens' PartnerClaim (Maybe Int64) Source #
Required. The ID of the customer for whom the device is being claimed.
pcDeviceMetadata :: Lens' PartnerClaim (Maybe DeviceMetadata) Source #
Required. The metadata to attach to the device at claim.
CustomerUnclaimDeviceRequest
data CustomerUnclaimDeviceRequest Source #
Request message for customer to unclaim a device.
See: customerUnclaimDeviceRequest smart constructor.
Instances
customerUnclaimDeviceRequest :: CustomerUnclaimDeviceRequest Source #
Creates a value of CustomerUnclaimDeviceRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cudrDevice :: Lens' CustomerUnclaimDeviceRequest (Maybe DeviceReference) Source #
Required. The device to unclaim.
PerDeviceStatusInBatchStatus
data PerDeviceStatusInBatchStatus Source #
The result status of the device after processing.
Constructors
| SingleDeviceStatusUnspecified |
|
| SingleDeviceStatusUnknownError |
|
| SingleDeviceStatusOtherError |
|
| SingleDeviceStatusSuccess |
|
| SingleDeviceStatusPermissionDenied |
|
| SingleDeviceStatusInvalidDeviceIdentifier |
|
| SingleDeviceStatusInvalidSectionType |
|
| SingleDeviceStatusSectionNotYours |
|
Instances
FindDevicesByOwnerRequestSectionType
data FindDevicesByOwnerRequestSectionType Source #
Required. The section type of the device's provisioning record.
Constructors
| SectionTypeUnspecified |
|
| SectionTypeSimLock |
|
| SectionTypeZeroTouch |
|
Instances
FindDevicesByDeviceIdentifierRequest
data FindDevicesByDeviceIdentifierRequest Source #
Request to find devices.
See: findDevicesByDeviceIdentifierRequest smart constructor.
Instances
findDevicesByDeviceIdentifierRequest :: FindDevicesByDeviceIdentifierRequest Source #
Creates a value of FindDevicesByDeviceIdentifierRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fdbdirDeviceIdentifier :: Lens' FindDevicesByDeviceIdentifierRequest (Maybe DeviceIdentifier) Source #
Required. The device identifier to search for.
fdbdirLimit :: Lens' FindDevicesByDeviceIdentifierRequest (Maybe Int64) Source #
Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
fdbdirPageToken :: Lens' FindDevicesByDeviceIdentifierRequest (Maybe Text) Source #
A token specifying which result page to return.
FindDevicesByOwnerResponse
data FindDevicesByOwnerResponse Source #
Response containing found devices.
See: findDevicesByOwnerResponse smart constructor.
Instances
findDevicesByOwnerResponse :: FindDevicesByOwnerResponse Source #
Creates a value of FindDevicesByOwnerResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fdborNextPageToken :: Lens' FindDevicesByOwnerResponse (Maybe Text) Source #
A token used to access the next page of results. Omitted if no further results are available.
fdborTotalSize :: Lens' FindDevicesByOwnerResponse (Maybe Int32) Source #
The total count of items in the list irrespective of pagination.
fdborDevices :: Lens' FindDevicesByOwnerResponse [Device] Source #
The customer's devices.
DeviceMetadataEntries
data DeviceMetadataEntries Source #
Metadata entries recorded as key-value pairs.
See: deviceMetadataEntries smart constructor.
Instances
deviceMetadataEntries Source #
Arguments
| :: HashMap Text Text | |
| -> DeviceMetadataEntries |
Creates a value of DeviceMetadataEntries with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
PartnerUnclaim
data PartnerUnclaim Source #
Identifies one unclaim request.
See: partnerUnclaim smart constructor.
Instances
partnerUnclaim :: PartnerUnclaim Source #
Creates a value of PartnerUnclaim with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
puDeviceIdentifier :: Lens' PartnerUnclaim (Maybe DeviceIdentifier) Source #
Device identifier of the device.
puSectionType :: Lens' PartnerUnclaim (Maybe PartnerUnclaimSectionType) Source #
Required. The section type of the device's provisioning record.
puDeviceId :: Lens' PartnerUnclaim (Maybe Int64) Source #
Device ID of the device.
Dpc
An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play.
See: dpc smart constructor.
Instances
| Eq Dpc Source # | |
| Data Dpc Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Dpc -> c Dpc # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Dpc # dataTypeOf :: Dpc -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Dpc) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Dpc) # gmapT :: (forall b. Data b => b -> b) -> Dpc -> Dpc # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Dpc -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Dpc -> r # gmapQ :: (forall d. Data d => d -> u) -> Dpc -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Dpc -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Dpc -> m Dpc # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Dpc -> m Dpc # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Dpc -> m Dpc # | |
| Show Dpc Source # | |
| Generic Dpc Source # | |
| ToJSON Dpc Source # | |
| FromJSON Dpc Source # | |
| type Rep Dpc Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product type Rep Dpc = D1 (MetaData "Dpc" "Network.Google.AndroidDeviceProvisioning.Types.Product" "gogol-androiddeviceprovisioning-0.4.0-8GRqRwv1LfcIpEsrUb285r" False) (C1 (MetaCons "Dpc'" PrefixI True) (S1 (MetaSel (Just "_dPackageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dDpcName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
Creates a value of Dpc with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dPackageName :: Lens' Dpc (Maybe Text) Source #
Output only. The DPC's Android application ID that looks like a Java package name. Zero-touch enrollment installs the DPC app onto a device using this identifier.
dName :: Lens' Dpc (Maybe Text) Source #
Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across customer accounts, persist and match the last path component (`DPC_ID`).
dDpcName :: Lens' Dpc (Maybe Text) Source #
Output only. The title of the DPC app in Google Play. For example, _Google Apps Device Policy_. Useful in an application's user interface.
ListVendorCustomersResponse
data ListVendorCustomersResponse Source #
Response message to list customers of the vendor.
See: listVendorCustomersResponse smart constructor.
Instances
listVendorCustomersResponse :: ListVendorCustomersResponse Source #
Creates a value of ListVendorCustomersResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvcrCustomers :: Lens' ListVendorCustomersResponse [Company] Source #
List of customers of the vendor.
lvcrNextPageToken :: Lens' ListVendorCustomersResponse (Maybe Text) Source #
A token to retrieve the next page of results. Omitted if no further results are available.
lvcrTotalSize :: Lens' ListVendorCustomersResponse (Maybe Int32) Source #
The total count of items in the list irrespective of pagination.
OperationPerDevice
data OperationPerDevice Source #
A task for each device in the operation. Corresponds to each device change in the request.
See: operationPerDevice smart constructor.
Instances
operationPerDevice :: OperationPerDevice Source #
Creates a value of OperationPerDevice with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
opdUpdateMetadata :: Lens' OperationPerDevice (Maybe UpdateMetadataArguments) Source #
A copy of the original metadata-update request received by the server.
opdResult :: Lens' OperationPerDevice (Maybe PerDeviceStatusInBatch) Source #
The processing result for each device.
opdClaim :: Lens' OperationPerDevice (Maybe PartnerClaim) Source #
A copy of the original device-claim request received by the server.
opdUnclaim :: Lens' OperationPerDevice (Maybe PartnerUnclaim) Source #
A copy of the original device-unclaim request received by the server.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
oError :: Lens' Operation (Maybe Status) Source #
This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
oName :: Lens' Operation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty smart constructor.
Instances
| Eq Empty Source # | |
| Data Empty Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
| Show Empty Source # | |
| Generic Empty Source # | |
| ToJSON Empty Source # | |
| FromJSON Empty Source # | |
| type Rep Empty Source # | |
PartnerClaimSectionType
data PartnerClaimSectionType Source #
Required. The section type of the device's provisioning record.
Constructors
| PCSTSectionTypeUnspecified |
|
| PCSTSectionTypeSimLock |
|
| PCSTSectionTypeZeroTouch |
|
Instances
PerDeviceStatusInBatch
data PerDeviceStatusInBatch Source #
Captures the processing status for each device in the operation.
See: perDeviceStatusInBatch smart constructor.
Instances
perDeviceStatusInBatch :: PerDeviceStatusInBatch Source #
Creates a value of PerDeviceStatusInBatch with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdsibStatus :: Lens' PerDeviceStatusInBatch (Maybe PerDeviceStatusInBatchStatus) Source #
The result status of the device after processing.
pdsibErrorIdentifier :: Lens' PerDeviceStatusInBatch (Maybe Text) Source #
If processing fails, the error type.
pdsibDeviceId :: Lens' PerDeviceStatusInBatch (Maybe Int64) Source #
If processing succeeds, the device ID of the device.
pdsibErrorMessage :: Lens' PerDeviceStatusInBatch (Maybe Text) Source #
If processing fails, a developer message explaining what went wrong.
ClaimDevicesRequest
data ClaimDevicesRequest Source #
Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.
See: claimDevicesRequest smart constructor.
Instances
claimDevicesRequest :: ClaimDevicesRequest Source #
Creates a value of ClaimDevicesRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdrClaims :: Lens' ClaimDevicesRequest [PartnerClaim] Source #
Required. A list of device claims.
Device
An Android device registered for zero-touch enrollment.
See: device smart constructor.
Instances
| Eq Device Source # | |
| Data Device Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Device -> c Device # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Device # toConstr :: Device -> Constr # dataTypeOf :: Device -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Device) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Device) # gmapT :: (forall b. Data b => b -> b) -> Device -> Device # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Device -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Device -> r # gmapQ :: (forall d. Data d => d -> u) -> Device -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Device -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Device -> m Device # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Device -> m Device # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Device -> m Device # | |
| Show Device Source # | |
| Generic Device Source # | |
| ToJSON Device Source # | |
| FromJSON Device Source # | |
| type Rep Device Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product type Rep Device = D1 (MetaData "Device" "Network.Google.AndroidDeviceProvisioning.Types.Product" "gogol-androiddeviceprovisioning-0.4.0-8GRqRwv1LfcIpEsrUb285r" False) (C1 (MetaCons "Device'" PrefixI True) ((S1 (MetaSel (Just "_devDeviceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeviceIdentifier)) :*: (S1 (MetaSel (Just "_devClaims") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DeviceClaim])) :*: S1 (MetaSel (Just "_devName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_devDeviceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_devDeviceMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeviceMetadata)) :*: S1 (MetaSel (Just "_devConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) | |
Creates a value of Device with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
devDeviceIdentifier :: Lens' Device (Maybe DeviceIdentifier) Source #
The hardware IDs that identify a manufactured device. To learn more, read Identifiers.
devClaims :: Lens' Device [DeviceClaim] Source #
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.
devName :: Lens' Device (Maybe Text) Source #
Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
devDeviceId :: Lens' Device (Maybe Int64) Source #
Output only. The ID of the device. Assigned by the server.
devDeviceMetadata :: Lens' Device (Maybe DeviceMetadata) Source #
The metadata attached to the device. Structured as key-value pairs. To learn more, read Device metadata.
ClaimDeviceRequest
data ClaimDeviceRequest Source #
Request message to claim a device on behalf of a customer.
See: claimDeviceRequest smart constructor.
Instances
claimDeviceRequest :: ClaimDeviceRequest Source #
Creates a value of ClaimDeviceRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdrDeviceIdentifier :: Lens' ClaimDeviceRequest (Maybe DeviceIdentifier) Source #
Required. The device identifier of the device to claim.
cdrSectionType :: Lens' ClaimDeviceRequest (Maybe ClaimDeviceRequestSectionType) Source #
Required. The section type of the device's provisioning record.
cdrCustomerId :: Lens' ClaimDeviceRequest (Maybe Int64) Source #
Required. The ID of the customer for whom the device is being claimed.
cdrDeviceMetadata :: Lens' ClaimDeviceRequest (Maybe DeviceMetadata) Source #
Optional. The metadata to attach to the device.
DeviceReference
data DeviceReference Source #
A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read Identifiers.
See: deviceReference smart constructor.
Instances
deviceReference :: DeviceReference Source #
Creates a value of DeviceReference with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drDeviceIdentifier :: Lens' DeviceReference (Maybe DeviceIdentifier) Source #
The hardware IDs of the device.
drDeviceId :: Lens' DeviceReference (Maybe Int64) Source #
The ID of the device.
CustomerRemoveConfigurationRequest
data CustomerRemoveConfigurationRequest Source #
Request message for customer to remove the configuration from device.
See: customerRemoveConfigurationRequest smart constructor.
Instances
customerRemoveConfigurationRequest :: CustomerRemoveConfigurationRequest Source #
Creates a value of CustomerRemoveConfigurationRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crcrDevice :: Lens' CustomerRemoveConfigurationRequest (Maybe DeviceReference) Source #
Required. The device to remove the configuration from.
DeviceIdentifier
data DeviceIdentifier Source #
Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers.
See: deviceIdentifier smart constructor.
Instances
deviceIdentifier :: DeviceIdentifier Source #
Creates a value of DeviceIdentifier with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diManufacturer :: Lens' DeviceIdentifier (Maybe Text) Source #
The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in manufacturers.
diModel :: Lens' DeviceIdentifier (Maybe Text) Source #
The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in models.
diSerialNumber :: Lens' DeviceIdentifier (Maybe Text) Source #
The manufacturer's serial number for the device. This value might not be unique across different device models.
UnclaimDevicesRequest
data UnclaimDevicesRequest Source #
Request to unclaim devices asynchronously in batch.
See: unclaimDevicesRequest smart constructor.
Instances
unclaimDevicesRequest :: UnclaimDevicesRequest Source #
Creates a value of UnclaimDevicesRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udrUnclaims :: Lens' UnclaimDevicesRequest [PartnerUnclaim] Source #
Required. The list of devices to unclaim.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> StatusDetailsItem |
Creates a value of StatusDetailsItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
ListVendorsResponse
data ListVendorsResponse Source #
Response message to list vendors of the partner.
See: listVendorsResponse smart constructor.
Instances
listVendorsResponse :: ListVendorsResponse Source #
Creates a value of ListVendorsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvrNextPageToken :: Lens' ListVendorsResponse (Maybe Text) Source #
A token to retrieve the next page of results. Omitted if no further results are available.
lvrTotalSize :: Lens' ListVendorsResponse (Maybe Int32) Source #
The total count of items in the list irrespective of pagination.
lvrVendors :: Lens' ListVendorsResponse [Company] Source #
List of vendors of the reseller partner. Fields `name`, `companyId` and `companyName` are populated to the Company object.
CustomerListConfigurationsResponse
data CustomerListConfigurationsResponse Source #
Response message of customer's listing configuration.
See: customerListConfigurationsResponse smart constructor.
Instances
customerListConfigurationsResponse :: CustomerListConfigurationsResponse Source #
Creates a value of CustomerListConfigurationsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clcrConfigurations :: Lens' CustomerListConfigurationsResponse [Configuration] Source #
The configurations.
PartnerUnclaimSectionType
data PartnerUnclaimSectionType Source #
Required. The section type of the device's provisioning record.
Constructors
| PUSTSectionTypeUnspecified |
|
| PUSTSectionTypeSimLock |
|
| PUSTSectionTypeZeroTouch |
|
Instances
CustomerApplyConfigurationRequest
data CustomerApplyConfigurationRequest Source #
Request message for customer to assign a configuration to device.
See: customerApplyConfigurationRequest smart constructor.
Instances
customerApplyConfigurationRequest :: CustomerApplyConfigurationRequest Source #
Creates a value of CustomerApplyConfigurationRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cacrDevice :: Lens' CustomerApplyConfigurationRequest (Maybe DeviceReference) Source #
Required. The device the configuration is applied to.
cacrConfiguration :: Lens' CustomerApplyConfigurationRequest (Maybe Text) Source #
Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
Company
A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
See: company smart constructor.
Instances
| Eq Company Source # | |
| Data Company Source # | |
Defined in Network.Google.AndroidDeviceProvisioning.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Company -> c Company # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Company # toConstr :: Company -> Constr # dataTypeOf :: Company -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Company) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Company) # gmapT :: (forall b. Data b => b -> b) -> Company -> Company # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Company -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Company -> r # gmapQ :: (forall d. Data d => d -> u) -> Company -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Company -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Company -> m Company # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Company -> m Company # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Company -> m Company # | |
| Show Company Source # | |
| Generic Company Source # | |