CreateAnnotationRequest

google.cloud.irm.v1alpha2. CreateAnnotationRequest

Represents a CreateAnnotationRequest.

Constructor

new CreateAnnotationRequest(propertiesopt)

Constructs a new CreateAnnotationRequest.

Parameters:
Name Type Attributes Description
properties google.cloud.irm.v1alpha2.ICreateAnnotationRequest <optional>

Properties to set

Implements:
  • ICreateAnnotationRequest

Members

annotation :google.cloud.irm.v1alpha2.IAnnotation|null|undefined

CreateAnnotationRequest annotation.

parent :string

CreateAnnotationRequest parent.

Methods

(static) create(propertiesopt) → {google.cloud.irm.v1alpha2.CreateAnnotationRequest}

Creates a new CreateAnnotationRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.irm.v1alpha2.ICreateAnnotationRequest <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.irm.v1alpha2.CreateAnnotationRequest}

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

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.irm.v1alpha2.CreateAnnotationRequest}

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

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

Reader or buffer to decode from

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

Parameters:
Name Type Attributes Description
message google.cloud.irm.v1alpha2.ICreateAnnotationRequest

CreateAnnotationRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.cloud.irm.v1alpha2.ICreateAnnotationRequest

CreateAnnotationRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.irm.v1alpha2.CreateAnnotationRequest}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.cloud.irm.v1alpha2.CreateAnnotationRequest

CreateAnnotationRequest

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a CreateAnnotationRequest message.

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

Plain object to verify

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

Converts this CreateAnnotationRequest to JSON.