Issue Command
|
|||||
|
|
||||
Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage Android devices and apps for your customers
Input
This building block consumes 8 input parameters
| Name | Format | Description |
|---|---|---|
name Required |
STRING |
The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId} |
duration |
ANY |
The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration |
errorCode |
ENUMERATION |
If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller |
createTime |
ANY |
The timestamp at which the command was created. The timestamp is automatically generated by the server |
newPassword |
STRING |
For commands of type RESET_PASSWORD, optionally specifies the new password |
resetPasswordFlags[] |
ENUMERATION |
|
userName |
STRING |
The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to |
type |
ENUMERATION |
The type of the command |
= Parameter name
= Format
|
name STRING Required The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId} |
|
duration ANY The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration |
|
errorCode ENUMERATION If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller |
|
createTime ANY The timestamp at which the command was created. The timestamp is automatically generated by the server |
|
newPassword STRING For commands of type RESET_PASSWORD, optionally specifies the new password |
|
resetPasswordFlags[] ENUMERATION |
|
userName STRING The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to |
|
type ENUMERATION The type of the command |
Output
This building block provides 11 output parameters
| Name | Format | Description |
|---|---|---|
metadata |
OBJECT |
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
metadata.customKey.value |
ANY |
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
done |
BOOLEAN |
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 |
response |
OBJECT |
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
response.customKey.value |
ANY |
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
name |
STRING |
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 be a resource name ending with operations/{unique_id} |
error |
OBJECT |
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 (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
error.message |
STRING |
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 |
error.details[] |
OBJECT |
|
error.details[].customKey.value |
ANY |
|
error.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
= Parameter name
= Format
|
metadata OBJECT Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
|
metadata.customKey.value ANY Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
|
done BOOLEAN 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 |
|
response OBJECT The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
|
response.customKey.value ANY The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
|
name STRING 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 be a resource name ending with operations/{unique_id} |
|
error OBJECT 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 (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
|
error.message STRING 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 |
|
error.details[] OBJECT |
|
error.details[].customKey.value ANY |
|
error.code INTEGER The status code, which should be an enum value of google.rpc.Code |