Class protos.google.cloud.dataplex.v1.ListEnvironmentsRequest (3.10.0)

Represents a ListEnvironmentsRequest.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.IListEnvironmentsRequest);

Constructs a new ListEnvironmentsRequest.

Parameter
Name Description
properties IListEnvironmentsRequest

Properties to set

Properties

filter

public filter: string;

ListEnvironmentsRequest filter.

orderBy

public orderBy: string;

ListEnvironmentsRequest orderBy.

pageSize

public pageSize: number;

ListEnvironmentsRequest pageSize.

pageToken

public pageToken: string;

ListEnvironmentsRequest pageToken.

parent

public parent: string;

ListEnvironmentsRequest parent.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IListEnvironmentsRequest): google.cloud.dataplex.v1.ListEnvironmentsRequest;

Creates a new ListEnvironmentsRequest instance using the specified properties.

Parameter
Name Description
properties IListEnvironmentsRequest

Properties to set

Returns
Type Description
ListEnvironmentsRequest

ListEnvironmentsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.ListEnvironmentsRequest;

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

ListEnvironmentsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.ListEnvironmentsRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ListEnvironmentsRequest

ListEnvironmentsRequest

encode(message, writer)

public static encode(message: google.cloud.dataplex.v1.IListEnvironmentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListEnvironmentsRequest message. Does not implicitly messages.

Parameters
Name Description
message IListEnvironmentsRequest

ListEnvironmentsRequest 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.dataplex.v1.IListEnvironmentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IListEnvironmentsRequest

ListEnvironmentsRequest 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.dataplex.v1.ListEnvironmentsRequest;

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

ListEnvironmentsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListEnvironmentsRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ListEnvironmentsRequest

ListEnvironmentsRequest

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