Cloud IoT V1 API - Class Google::Cloud::Iot::V1::DeviceManager::Rest::ServiceStub (v0.9.1)

Reference documentation and code samples for the Cloud IoT V1 API class Google::Cloud::Iot::V1::DeviceManager::Rest::ServiceStub.

REST service stub for the DeviceManager service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#bind_device_to_gateway

def bind_device_to_gateway(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::BindDeviceToGatewayResponse

Baseline implementation for the bind_device_to_gateway REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_device

def create_device(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::Device

Baseline implementation for the create_device REST call

Parameters
  • request_pb (::Google::Cloud::Iot::V1::CreateDeviceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_device_registry

def create_device_registry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::DeviceRegistry

Baseline implementation for the create_device_registry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_device

def delete_device(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_device REST call

Parameters
  • request_pb (::Google::Cloud::Iot::V1::DeleteDeviceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_device_registry

def delete_device_registry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_device_registry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_device

def get_device(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::Device

Baseline implementation for the get_device REST call

Parameters
  • request_pb (::Google::Cloud::Iot::V1::GetDeviceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_device_registry

def get_device_registry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::DeviceRegistry

Baseline implementation for the get_device_registry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_iam_policy

def get_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy

Baseline implementation for the get_iam_policy REST call

Parameters
  • request_pb (::Google::Iam::V1::GetIamPolicyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#list_device_config_versions

def list_device_config_versions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse

Baseline implementation for the list_device_config_versions REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_device_registries

def list_device_registries(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::ListDeviceRegistriesResponse

Baseline implementation for the list_device_registries REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_device_states

def list_device_states(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::ListDeviceStatesResponse

Baseline implementation for the list_device_states REST call

Parameters
  • request_pb (::Google::Cloud::Iot::V1::ListDeviceStatesRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_devices

def list_devices(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::ListDevicesResponse

Baseline implementation for the list_devices REST call

Parameters
  • request_pb (::Google::Cloud::Iot::V1::ListDevicesRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#modify_cloud_to_device_config

def modify_cloud_to_device_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::DeviceConfig

Baseline implementation for the modify_cloud_to_device_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#send_command_to_device

def send_command_to_device(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::SendCommandToDeviceResponse

Baseline implementation for the send_command_to_device REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#set_iam_policy

def set_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy

Baseline implementation for the set_iam_policy REST call

Parameters
  • request_pb (::Google::Iam::V1::SetIamPolicyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#test_iam_permissions

def test_iam_permissions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::TestIamPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters
  • request_pb (::Google::Iam::V1::TestIamPermissionsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#unbind_device_from_gateway

def unbind_device_from_gateway(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse

Baseline implementation for the unbind_device_from_gateway REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_device

def update_device(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::Device

Baseline implementation for the update_device REST call

Parameters
  • request_pb (::Google::Cloud::Iot::V1::UpdateDeviceRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_device_registry

def update_device_registry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Iot::V1::DeviceRegistry

Baseline implementation for the update_device_registry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)