Filter

google.cloud.billing.budgets.v1. Filter

Represents a Filter.

Constructor

new Filter(propertiesopt)

Constructs a new Filter.

Parameters:
Name Type Attributes Description
properties google.cloud.billing.budgets.v1.IFilter <optional>

Properties to set

Implements:
  • IFilter

Members

calendarPeriod

Filter calendarPeriod.

creditTypes

Filter creditTypes.

creditTypesTreatment

Filter creditTypesTreatment.

customPeriod

Filter customPeriod.

labels

Filter labels.

projects

Filter projects.

services

Filter services.

subaccounts

Filter subaccounts.

usagePeriod

Filter usagePeriod.

CreditTypesTreatment

CreditTypesTreatment enum.

Properties:
Name Type Description
CREDIT_TYPES_TREATMENT_UNSPECIFIED number

CREDIT_TYPES_TREATMENT_UNSPECIFIED value

INCLUDE_ALL_CREDITS number

INCLUDE_ALL_CREDITS value

EXCLUDE_ALL_CREDITS number

EXCLUDE_ALL_CREDITS value

INCLUDE_SPECIFIED_CREDITS number

INCLUDE_SPECIFIED_CREDITS value

Methods

toJSON() → {Object.<string, *>}

Converts this Filter to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.billing.budgets.v1.Filter}

Creates a new Filter instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.billing.budgets.v1.IFilter <optional>

Properties to set

Returns:
Type Description
google.cloud.billing.budgets.v1.Filter

Filter instance

(static) decode(reader, lengthopt) → {google.cloud.billing.budgets.v1.Filter}

Decodes a Filter message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.billing.budgets.v1.Filter

Filter

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.billing.budgets.v1.Filter}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.billing.budgets.v1.Filter

Filter

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Filter message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.billing.budgets.v1.IFilter

Filter message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.billing.budgets.v1.IFilter

Filter message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.billing.budgets.v1.Filter}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.billing.budgets.v1.Filter

Filter

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Filter

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.billing.budgets.v1.Filter

Filter

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Filter message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not