Class protos.google.cloud.bigquery.reservation.v1.CreateAssignmentRequest (3.4.0)

Represents a CreateAssignmentRequest.

Package

@google-cloud/bigquery-reservation

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest);

Constructs a new CreateAssignmentRequest.

Parameter
Name Description
properties ICreateAssignmentRequest

Properties to set

Properties

assignment

public assignment?: (google.cloud.bigquery.reservation.v1.IAssignment|null);

CreateAssignmentRequest assignment.

assignmentId

public assignmentId: string;

CreateAssignmentRequest assignmentId.

parent

public parent: string;

CreateAssignmentRequest parent.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest): google.cloud.bigquery.reservation.v1.CreateAssignmentRequest;

Creates a new CreateAssignmentRequest instance using the specified properties.

Parameter
Name Description
properties ICreateAssignmentRequest

Properties to set

Returns
Type Description
CreateAssignmentRequest

CreateAssignmentRequest instance

decode(reader, length)

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

Decodes a CreateAssignmentRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
CreateAssignmentRequest

CreateAssignmentRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.reservation.v1.CreateAssignmentRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CreateAssignmentRequest

CreateAssignmentRequest

encode(message, writer)

public static encode(message: google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateAssignmentRequest message. Does not implicitly messages.

Parameters
Name Description
message ICreateAssignmentRequest

CreateAssignmentRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.bigquery.reservation.v1.ICreateAssignmentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICreateAssignmentRequest

CreateAssignmentRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.reservation.v1.CreateAssignmentRequest;

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
CreateAssignmentRequest

CreateAssignmentRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CreateAssignmentRequest

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this CreateAssignmentRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CreateAssignmentRequest

CreateAssignmentRequest

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CreateAssignmentRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not