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