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