Pipeline

google.cloud.eventarc.v1. Pipeline

Represents a Pipeline.

Constructor

new Pipeline(propertiesopt)

Constructs a new Pipeline.

Parameters:
Name Type Attributes Description
properties google.cloud.eventarc.v1.IPipeline <optional>

Properties to set

Implements:
  • IPipeline

Classes

Destination
Mediation
MessagePayloadFormat
RetryPolicy

Members

annotations

Pipeline annotations.

createTime

Pipeline createTime.

cryptoKeyName

Pipeline cryptoKeyName.

destinations

Pipeline destinations.

displayName

Pipeline displayName.

etag

Pipeline etag.

inputPayloadFormat

Pipeline inputPayloadFormat.

labels

Pipeline labels.

loggingConfig

Pipeline loggingConfig.

mediations

Pipeline mediations.

name

Pipeline name.

retryPolicy

Pipeline retryPolicy.

uid

Pipeline uid.

updateTime

Pipeline updateTime.

Methods

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

Converts this Pipeline to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.eventarc.v1.Pipeline}

Creates a new Pipeline instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.eventarc.v1.IPipeline <optional>

Properties to set

Returns:
Type Description
google.cloud.eventarc.v1.Pipeline

Pipeline instance

(static) decode(reader, lengthopt) → {google.cloud.eventarc.v1.Pipeline}

Decodes a Pipeline 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.eventarc.v1.Pipeline

Pipeline

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.eventarc.v1.Pipeline}

Decodes a Pipeline 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.eventarc.v1.Pipeline

Pipeline

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

Parameters:
Name Type Attributes Description
message google.cloud.eventarc.v1.IPipeline

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

Parameters:
Name Type Attributes Description
message google.cloud.eventarc.v1.IPipeline

Pipeline 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.eventarc.v1.Pipeline}

Creates a Pipeline 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.eventarc.v1.Pipeline

Pipeline

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Pipeline

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

Parameters:
Name Type Attributes Description
message google.cloud.eventarc.v1.Pipeline

Pipeline

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Pipeline 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