1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudIot
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsRegistries

ProjectsLocationsRegistries

class ProjectsLocationsRegistries extends Resource (View source)

The "registries" collection of methods.

Typical usage is:

 $cloudiotService = new Google\Service\CloudIot(...);
 $registries = $cloudiotService->projects_locations_registries;

Methods

BindDeviceToGatewayResponse
bindDeviceToGateway(string $parent, BindDeviceToGatewayRequest $postBody, array $optParams = [])

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

DeviceRegistry
create(string $parent, DeviceRegistry $postBody, array $optParams = [])

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

CloudiotEmpty
delete(string $name, array $optParams = [])

Deletes a device registry configuration. (registries.delete)

DeviceRegistry
get(string $name, array $optParams = [])

Gets a device registry configuration. (registries.get)

Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

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)

ListDeviceRegistriesResponse
listProjectsLocationsRegistries(string $parent, array $optParams = [])

Lists device registries. (registries.listProjectsLocationsRegistries)

DeviceRegistry
patch(string $name, DeviceRegistry $postBody, array $optParams = [])

Updates a device registry configuration. (registries.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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)

UnbindDeviceFromGatewayResponse
unbindDeviceFromGateway(string $parent, UnbindDeviceFromGatewayRequest $postBody, array $optParams = [])

Deletes the association between the device and the gateway.

Details

at line 52
BindDeviceToGatewayResponse bindDeviceToGateway(string $parent, BindDeviceToGatewayRequest $postBody, array $optParams = [])

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

Parameters

string $parent

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.
BindDeviceToGatewayRequest $postBody
array $optParams

Optional parameters.

Return Value

BindDeviceToGatewayResponse

at line 68
DeviceRegistry create(string $parent, DeviceRegistry $postBody, array $optParams = [])

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

Parameters

string $parent

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

Optional parameters.

Return Value

DeviceRegistry

at line 82
CloudiotEmpty delete(string $name, array $optParams = [])

Deletes a device registry configuration. (registries.delete)

Parameters

string $name

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

Optional parameters.

Return Value

CloudiotEmpty

at line 96
DeviceRegistry get(string $name, array $optParams = [])

Gets a device registry configuration. (registries.get)

Parameters

string $name

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

Optional parameters.

Return Value

DeviceRegistry

at line 114
Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

at line 137
ListDeviceRegistriesResponse listProjectsLocationsRegistries(string $parent, array $optParams = [])

Lists device registries. (registries.listProjectsLocationsRegistries)

Parameters

string $parent

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

Optional parameters.

Return Value

ListDeviceRegistriesResponse

at line 158
DeviceRegistry patch(string $name, DeviceRegistry $postBody, array $optParams = [])

Updates a device registry configuration. (registries.patch)

Parameters

string $name

The resource path name. For example, projects/example- project/locations/us-central1/registries/my-registry.
DeviceRegistry $postBody
array $optParams

Optional parameters.

Return Value

DeviceRegistry

at line 176
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

at line 195
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

at line 211
UnbindDeviceFromGatewayResponse unbindDeviceFromGateway(string $parent, UnbindDeviceFromGatewayRequest $postBody, array $optParams = [])

Deletes the association between the device and the gateway.

(registries.unbindDeviceFromGateway)

Parameters

string $parent

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.
UnbindDeviceFromGatewayRequest $postBody
array $optParams

Optional parameters.

Return Value

UnbindDeviceFromGatewayResponse