Operation

google.cloud.recommender.v1. Operation

Represents an Operation.

Constructor

new Operation(propertiesopt)

Constructs a new Operation.

Parameters:
Name Type Attributes Description
properties google.cloud.recommender.v1.IOperation <optional>

Properties to set

Implements:
  • IOperation

Members

action

Operation action.

path

Operation path.

pathFilters

Operation pathFilters.

pathValue

Operation pathValue.

pathValueMatchers

Operation pathValueMatchers.

resource

Operation resource.

resourceType

Operation resourceType.

sourcePath

Operation sourcePath.

sourceResource

Operation sourceResource.

value

Operation value.

valueMatcher

Operation valueMatcher.

Methods

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

Converts this Operation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.recommender.v1.Operation}

Creates a new Operation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.recommender.v1.IOperation <optional>

Properties to set

Returns:
Type Description
google.cloud.recommender.v1.Operation

Operation instance

(static) decode(reader, lengthopt) → {google.cloud.recommender.v1.Operation}

Decodes an Operation 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.recommender.v1.Operation

Operation

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.recommender.v1.Operation}

Decodes an Operation 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.recommender.v1.Operation

Operation

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 Operation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recommender.v1.IOperation

Operation 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 Operation message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recommender.v1.IOperation

Operation 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.recommender.v1.Operation}

Creates an Operation 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.recommender.v1.Operation

Operation

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Operation

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 an Operation message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.recommender.v1.Operation

Operation

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an Operation 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