Class protos.google.cloud.datastream.v1.StopBackfillJobResponse (3.1.0)

Represents a StopBackfillJobResponse.

Package

@google-cloud/datastream

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datastream.v1.IStopBackfillJobResponse);

Constructs a new StopBackfillJobResponse.

Parameter
NameDescription
properties IStopBackfillJobResponse

Properties to set

Properties

object

public object?: (google.cloud.datastream.v1.IStreamObject|null);

StopBackfillJobResponse object.

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1.IStopBackfillJobResponse): google.cloud.datastream.v1.StopBackfillJobResponse;

Creates a new StopBackfillJobResponse instance using the specified properties.

Parameter
NameDescription
properties IStopBackfillJobResponse

Properties to set

Returns
TypeDescription
StopBackfillJobResponse

StopBackfillJobResponse instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1.StopBackfillJobResponse;

Decodes a StopBackfillJobResponse message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
StopBackfillJobResponse

StopBackfillJobResponse

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1.StopBackfillJobResponse;

Decodes a StopBackfillJobResponse message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
StopBackfillJobResponse

StopBackfillJobResponse

encode(message, writer)

public static encode(message: google.cloud.datastream.v1.IStopBackfillJobResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified StopBackfillJobResponse message. Does not implicitly messages.

Parameters
NameDescription
message IStopBackfillJobResponse

StopBackfillJobResponse message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datastream.v1.IStopBackfillJobResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified StopBackfillJobResponse message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IStopBackfillJobResponse

StopBackfillJobResponse message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datastream.v1.StopBackfillJobResponse;

Creates a StopBackfillJobResponse message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
StopBackfillJobResponse

StopBackfillJobResponse

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for StopBackfillJobResponse

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this StopBackfillJobResponse to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.datastream.v1.StopBackfillJobResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a StopBackfillJobResponse message. Also converts values to other types if specified.

Parameters
NameDescription
message StopBackfillJobResponse

StopBackfillJobResponse

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a StopBackfillJobResponse message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not