Class protos.google.cloud.dataproc.v1.TemplateParameter (5.12.0)

Represents a TemplateParameter.

Package

@google-cloud/dataproc

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataproc.v1.ITemplateParameter);

Constructs a new TemplateParameter.

Parameter
Name Description
properties ITemplateParameter

Properties to set

Properties

description

public description: string;

TemplateParameter description.

fields

public fields: string[];

TemplateParameter fields.

name

public name: string;

TemplateParameter name.

validation

public validation?: (google.cloud.dataproc.v1.IParameterValidation|null);

TemplateParameter validation.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.ITemplateParameter): google.cloud.dataproc.v1.TemplateParameter;

Creates a new TemplateParameter instance using the specified properties.

Parameter
Name Description
properties ITemplateParameter

Properties to set

Returns
Type Description
TemplateParameter

TemplateParameter instance

decode(reader, length)

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

Decodes a TemplateParameter 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
TemplateParameter

TemplateParameter

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TemplateParameter

TemplateParameter

encode(message, writer)

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

Encodes the specified TemplateParameter message. Does not implicitly messages.

Parameters
Name Description
message ITemplateParameter

TemplateParameter 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.dataproc.v1.ITemplateParameter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITemplateParameter

TemplateParameter 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.dataproc.v1.TemplateParameter;

Creates a TemplateParameter 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
TemplateParameter

TemplateParameter

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TemplateParameter

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 TemplateParameter to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TemplateParameter

TemplateParameter

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 TemplateParameter 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