Class SendCommandToDeviceRequest (2.42.0)

public final class SendCommandToDeviceRequest extends GeneratedMessageV3 implements SendCommandToDeviceRequestOrBuilder

Request for SendCommandToDevice.

Protobuf type google.cloud.iot.v1.SendCommandToDeviceRequest

Static Fields

BINARY_DATA_FIELD_NUMBER

public static final int BINARY_DATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SUBFOLDER_FIELD_NUMBER

public static final int SUBFOLDER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SendCommandToDeviceRequest getDefaultInstance()
Returns
Type Description
SendCommandToDeviceRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SendCommandToDeviceRequest.Builder newBuilder()
Returns
Type Description
SendCommandToDeviceRequest.Builder

newBuilder(SendCommandToDeviceRequest prototype)

public static SendCommandToDeviceRequest.Builder newBuilder(SendCommandToDeviceRequest prototype)
Parameter
Name Description
prototype SendCommandToDeviceRequest
Returns
Type Description
SendCommandToDeviceRequest.Builder

parseDelimitedFrom(InputStream input)

public static SendCommandToDeviceRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SendCommandToDeviceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SendCommandToDeviceRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SendCommandToDeviceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SendCommandToDeviceRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SendCommandToDeviceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SendCommandToDeviceRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SendCommandToDeviceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SendCommandToDeviceRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SendCommandToDeviceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SendCommandToDeviceRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SendCommandToDeviceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SendCommandToDeviceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SendCommandToDeviceRequest> parser()
Returns
Type Description
Parser<SendCommandToDeviceRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBinaryData()

public ByteString getBinaryData()

Required. The command data to send to the device.

bytes binary_data = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The binaryData.

getDefaultInstanceForType()

public SendCommandToDeviceRequest getDefaultInstanceForType()
Returns
Type Description
SendCommandToDeviceRequest

getName()

public String getName()

Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SendCommandToDeviceRequest> getParserForType()
Returns
Type Description
Parser<SendCommandToDeviceRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubfolder()

public String getSubfolder()

Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters.

string subfolder = 3;

Returns
Type Description
String

The subfolder.

getSubfolderBytes()

public ByteString getSubfolderBytes()

Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters.

string subfolder = 3;

Returns
Type Description
ByteString

The bytes for subfolder.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SendCommandToDeviceRequest.Builder newBuilderForType()
Returns
Type Description
SendCommandToDeviceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SendCommandToDeviceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SendCommandToDeviceRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SendCommandToDeviceRequest.Builder toBuilder()
Returns
Type Description
SendCommandToDeviceRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException