Class protos.google.cloud.alloydb.v1beta.ListUsersResponse (1.10.1)

Represents a ListUsersResponse.

Package

@google-cloud/alloydb

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.alloydb.v1beta.IListUsersResponse);

Constructs a new ListUsersResponse.

Parameter
Name Description
properties IListUsersResponse

Properties to set

Properties

nextPageToken

public nextPageToken: string;

ListUsersResponse nextPageToken.

unreachable

public unreachable: string[];

ListUsersResponse unreachable.

users

public users: google.cloud.alloydb.v1beta.IUser[];

ListUsersResponse users.

Methods

create(properties)

public static create(properties?: google.cloud.alloydb.v1beta.IListUsersResponse): google.cloud.alloydb.v1beta.ListUsersResponse;

Creates a new ListUsersResponse instance using the specified properties.

Parameter
Name Description
properties IListUsersResponse

Properties to set

Returns
Type Description
ListUsersResponse

ListUsersResponse instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.alloydb.v1beta.ListUsersResponse;

Decodes a ListUsersResponse 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
ListUsersResponse

ListUsersResponse

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.alloydb.v1beta.ListUsersResponse;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ListUsersResponse

ListUsersResponse

encode(message, writer)

public static encode(message: google.cloud.alloydb.v1beta.IListUsersResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListUsersResponse message. Does not implicitly messages.

Parameters
Name Description
message IListUsersResponse

ListUsersResponse 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.v1beta.IListUsersResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IListUsersResponse

ListUsersResponse 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.v1beta.ListUsersResponse;

Creates a ListUsersResponse 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
ListUsersResponse

ListUsersResponse

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ListUsersResponse

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 ListUsersResponse to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ListUsersResponse

ListUsersResponse

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 ListUsersResponse 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