Represents a ParameterMetadata.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IParameterMetadata);
Constructs a new ParameterMetadata.
Parameter | |
---|---|
Name | Description |
properties |
IParameterMetadata
Properties to set |
Properties
customMetadata
public customMetadata: { [k: string]: string };
ParameterMetadata customMetadata.
helpText
public helpText: string;
ParameterMetadata helpText.
isOptional
public isOptional: boolean;
ParameterMetadata isOptional.
label
public label: string;
ParameterMetadata label.
name
public name: string;
ParameterMetadata name.
paramType
public paramType: (google.dataflow.v1beta3.ParameterType|keyof typeof google.dataflow.v1beta3.ParameterType);
ParameterMetadata paramType.
regexes
public regexes: string[];
ParameterMetadata regexes.
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.IParameterMetadata): google.dataflow.v1beta3.ParameterMetadata;
Creates a new ParameterMetadata instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IParameterMetadata
Properties to set |
Returns | |
---|---|
Type | Description |
ParameterMetadata | ParameterMetadata instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.ParameterMetadata;
Decodes a ParameterMetadata 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 |
ParameterMetadata | ParameterMetadata |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.ParameterMetadata;
Decodes a ParameterMetadata message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
ParameterMetadata | ParameterMetadata |
encode(message, writer)
public static encode(message: google.dataflow.v1beta3.IParameterMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ParameterMetadata message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IParameterMetadata
ParameterMetadata 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.dataflow.v1beta3.IParameterMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ParameterMetadata message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IParameterMetadata
ParameterMetadata 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.dataflow.v1beta3.ParameterMetadata;
Creates a ParameterMetadata 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 |
ParameterMetadata | ParameterMetadata |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for ParameterMetadata
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 ParameterMetadata to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.dataflow.v1beta3.ParameterMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a ParameterMetadata message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
ParameterMetadata
ParameterMetadata |
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 ParameterMetadata message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|