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