Class protos.google.cloud.billing.budgets.v1.Filter

Represents a Filter.

Package

@google-cloud/billing-budgets

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.billing.budgets.v1.IFilter);

Constructs a new Filter.

Parameter
NameDescription
properties IFilter

Properties to set

Properties

calendarPeriod

public calendarPeriod?: (google.cloud.billing.budgets.v1.CalendarPeriod|keyof typeof google.cloud.billing.budgets.v1.CalendarPeriod|null);

Filter calendarPeriod.

creditTypes

public creditTypes: string[];

Filter creditTypes.

creditTypesTreatment

public creditTypesTreatment: (google.cloud.billing.budgets.v1.Filter.CreditTypesTreatment|keyof typeof google.cloud.billing.budgets.v1.Filter.CreditTypesTreatment);

Filter creditTypesTreatment.

customPeriod

public customPeriod?: (google.cloud.billing.budgets.v1.ICustomPeriod|null);

Filter customPeriod.

labels

public labels: { [k: string]: google.protobuf.IListValue };

Filter labels.

projects

public projects: string[];

Filter projects.

services

public services: string[];

Filter services.

subaccounts

public subaccounts: string[];

Filter subaccounts.

usagePeriod

public usagePeriod?: ("calendarPeriod"|"customPeriod");

Filter usagePeriod.

Methods

create(properties)

public static create(properties?: google.cloud.billing.budgets.v1.IFilter): google.cloud.billing.budgets.v1.Filter;

Creates a new Filter instance using the specified properties.

Parameter
NameDescription
properties IFilter

Properties to set

Returns
TypeDescription
google.cloud.billing.budgets.v1.Filter

Filter instance

decode(reader, length)

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

Decodes a Filter message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.billing.budgets.v1.Filter

Filter

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.billing.budgets.v1.Filter;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.billing.budgets.v1.Filter

Filter

encode(message, writer)

public static encode(message: google.cloud.billing.budgets.v1.IFilter, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Filter message. Does not implicitly messages.

Parameters
NameDescription
message IFilter

Filter message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.billing.budgets.v1.IFilter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IFilter

Filter message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.billing.budgets.v1.Filter;

Creates a Filter message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.billing.budgets.v1.Filter

Filter

toJSON()

public toJSON(): { [k: string]: any };

Converts this Filter to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.billing.budgets.v1.Filter

Filter

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Filter message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not