Class: ResponseFormat

ResponseFormat(opt_dataopt)

new ResponseFormat(opt_dataopt)

Generated by JsPbCodeGenerator.
Parameters:
Name Type Attributes Description
opt_data Array <optional>
 Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.
Source:

Extends

  • jspb.Message

Members

(static) displayName

Source:

Methods

clearFieldMask() → (non-null) {proto.spine.client.ResponseFormat}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.client.ResponseFormat

clearOrderBy() → (non-null) {proto.spine.client.ResponseFormat}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.client.ResponseFormat

getFieldMask() → (nullable) {proto.google.protobuf.FieldMask}

optional google.protobuf.FieldMask field_mask = 1;
Source:
Returns:
Type
proto.google.protobuf.FieldMask

getLimit() → {number}

optional uint32 limit = 3;
Source:
Returns:
Type
number

getOrderBy() → (nullable) {proto.spine.client.OrderBy}

optional OrderBy order_by = 2;
Source:
Returns:
Type
proto.spine.client.OrderBy

hasFieldMask() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasOrderBy() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setFieldMask(value) → (non-null) {proto.spine.client.ResponseFormat}

Parameters:
Name Type Description
value proto.google.protobuf.FieldMask | undefined
Source:
Returns:
returns this
Type
proto.spine.client.ResponseFormat

setLimit(value) → (non-null) {proto.spine.client.ResponseFormat}

Parameters:
Name Type Description
value number
Source:
Returns:
returns this
Type
proto.spine.client.ResponseFormat

setOrderBy(value) → (non-null) {proto.spine.client.ResponseFormat}

Parameters:
Name Type Description
value proto.spine.client.OrderBy | undefined
Source:
Returns:
returns this
Type
proto.spine.client.ResponseFormat

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.
Parameters:
Name Type Attributes Description
opt_includeInstance boolean <optional>
 Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
Source:
Returns:
Type
Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.client.ResponseFormat}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.spine.client.ResponseFormat

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.spine.client.ResponseFormat}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.spine.client.ResponseFormat The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.spine.client.ResponseFormat

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.
Parameters:
Name Type Description
message proto.spine.client.ResponseFormat
writer jspb.BinaryWriter
Source:

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.
Parameters:
Name Type Description
includeInstance boolean | undefined Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
msg proto.spine.client.ResponseFormat The msg instance to transform.
Source:
Returns:
Type
Object