Documentation

Google_Service_CloudIot_Resource_ProjectsLocationsRegistries extends Google_Service_Resource
in package

The "registries" collection of methods.

Typical usage is: $cloudiotService = new Google_Service_CloudIot(...); $registries = $cloudiotService->registries;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
bindDeviceToGateway()  : Google_Service_CloudIot_BindDeviceToGatewayResponse
Associates the device with the gateway. (registries.bindDeviceToGateway)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudIot_DeviceRegistry
Creates a device registry that contains devices. (registries.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudIot_CloudiotEmpty
Deletes a device registry configuration. (registries.delete)
get()  : Google_Service_CloudIot_DeviceRegistry
Gets a device registry configuration. (registries.get)
getIamPolicy()  : Google_Service_CloudIot_Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (registries.getIamPolicy)
listProjectsLocationsRegistries()  : Google_Service_CloudIot_ListDeviceRegistriesResponse
Lists device registries. (registries.listProjectsLocationsRegistries)
patch()  : Google_Service_CloudIot_DeviceRegistry
Updates a device registry configuration. (registries.patch)
setIamPolicy()  : Google_Service_CloudIot_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. (registries.setIamPolicy)
testIamPermissions()  : Google_Service_CloudIot_TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. (registries.testIamPermissions)
unbindDeviceFromGateway()  : Google_Service_CloudIot_UnbindDeviceFromGatewayResponse
Deletes the association between the device and the gateway.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

bindDeviceToGateway()

Associates the device with the gateway. (registries.bindDeviceToGateway)

public bindDeviceToGateway(string $parent, Google_Service_CloudIot_BindDeviceToGatewayRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_BindDeviceToGatewayResponse
Parameters
$parent : string

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

$postBody : Google_Service_CloudIot_BindDeviceToGatewayRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_BindDeviceToGatewayResponse —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a device registry that contains devices. (registries.create)

public create(string $parent, Google_Service_CloudIot_DeviceRegistry $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_DeviceRegistry
Parameters
$parent : string

Required. The project and cloud region where this device registry must be created. For example, projects/example- project/locations/us-central1.

$postBody : Google_Service_CloudIot_DeviceRegistry
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_DeviceRegistry —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a device registry configuration. (registries.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_CloudiotEmpty
Parameters
$name : string

Required. The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_CloudiotEmpty —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (registries.getIamPolicy)

public getIamPolicy(string $resource, Google_Service_CloudIot_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudIot_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_Policy —

listProjectsLocationsRegistries()

Lists device registries. (registries.listProjectsLocationsRegistries)

public listProjectsLocationsRegistries(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_ListDeviceRegistriesResponse
Parameters
$parent : string

Required. The project and cloud region path. For example, projects/example-project/locations/us-central1.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

opt_param

string pageToken The value returned by the last ListDeviceRegistriesResponse; indicates that this is a continuation of a prior ListDeviceRegistries call and the system should return the next page of data.

Return values
Google_Service_CloudIot_ListDeviceRegistriesResponse —

patch()

Updates a device registry configuration. (registries.patch)

public patch(string $name, Google_Service_CloudIot_DeviceRegistry $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_DeviceRegistry
Parameters
$name : string

The resource path name. For example, projects/example- project/locations/us-central1/registries/my-registry.

$postBody : Google_Service_CloudIot_DeviceRegistry
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Required. Only updates the device_registry fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top- level fields: event_notification_config, http_config, mqtt_config, and state_notification_config.

Return values
Google_Service_CloudIot_DeviceRegistry —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. (registries.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_CloudIot_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudIot_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_Policy —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. (registries.testIamPermissions)

public testIamPermissions(string $resource, Google_Service_CloudIot_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_TestIamPermissionsResponse
Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudIot_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_TestIamPermissionsResponse —

unbindDeviceFromGateway()

Deletes the association between the device and the gateway.

public unbindDeviceFromGateway(string $parent, Google_Service_CloudIot_UnbindDeviceFromGatewayRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIot_UnbindDeviceFromGatewayResponse

(registries.unbindDeviceFromGateway)

Parameters
$parent : string

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

$postBody : Google_Service_CloudIot_UnbindDeviceFromGatewayRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIot_UnbindDeviceFromGatewayResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results