Class protos.google.cloud.dataproc.v1.ParameterValidation (2.5.0)

Represents a ParameterValidation.

Package

@google-cloud/dataproc!

Constructors

(constructor)(properties)

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

Constructs a new ParameterValidation.

Parameter

Name	Description
properties	`IParameterValidation` Properties to set

Properties

regex

public regex?: (google.cloud.dataproc.v1.IRegexValidation|null);

ParameterValidation regex.

Property Value

Type	Description
(google.cloud.dataproc.v1.IRegexValidation\|null)

validationType

public validationType?: ("regex"|"values");

ParameterValidation validationType.

Property Value

Type	Description
("regex"\|"values")

values

public values?: (google.cloud.dataproc.v1.IValueValidation|null);

ParameterValidation values.

Property Value

Type	Description
(google.cloud.dataproc.v1.IValueValidation\|null)

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IParameterValidation): google.cloud.dataproc.v1.ParameterValidation;

Creates a new ParameterValidation instance using the specified properties.

Parameter

Name	Description
properties	`IParameterValidation` Properties to set

Returns

Type	Description
google.cloud.dataproc.v1.ParameterValidation	ParameterValidation instance

decode(reader, length)

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

Decodes a ParameterValidation message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.dataproc.v1.ParameterValidation	ParameterValidation

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.dataproc.v1.ParameterValidation	ParameterValidation

encode(message, writer)

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

Encodes the specified ParameterValidation message. Does not implicitly messages.

Parameters

Name	Description
message	`IParameterValidation` ParameterValidation 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.IParameterValidation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IParameterValidation` ParameterValidation 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.ParameterValidation;

Creates a ParameterValidation 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
google.cloud.dataproc.v1.ParameterValidation	ParameterValidation

toJSON()

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

Converts this ParameterValidation to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dataproc.v1.ParameterValidation` ParameterValidation
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 ParameterValidation 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