IngestionDataSourceSettings

google.pubsub.v1. IngestionDataSourceSettings

Represents an IngestionDataSourceSettings.

Constructor

new IngestionDataSourceSettings(propertiesopt)

Constructs a new IngestionDataSourceSettings.

Parameters:
Name Type Attributes Description
properties google.pubsub.v1.IIngestionDataSourceSettings <optional>

Properties to set

Implements:
  • IIngestionDataSourceSettings

Classes

AwsKinesis
AwsMsk
AzureEventHubs
CloudStorage
ConfluentCloud

Members

awsKinesis

IngestionDataSourceSettings awsKinesis.

awsMsk

IngestionDataSourceSettings awsMsk.

azureEventHubs

IngestionDataSourceSettings azureEventHubs.

cloudStorage

IngestionDataSourceSettings cloudStorage.

confluentCloud

IngestionDataSourceSettings confluentCloud.

platformLogsSettings

IngestionDataSourceSettings platformLogsSettings.

source

IngestionDataSourceSettings source.

Methods

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

Converts this IngestionDataSourceSettings to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.pubsub.v1.IngestionDataSourceSettings}

Creates a new IngestionDataSourceSettings instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.pubsub.v1.IIngestionDataSourceSettings <optional>

Properties to set

Returns:
Type Description
google.pubsub.v1.IngestionDataSourceSettings

IngestionDataSourceSettings instance

(static) decode(reader, lengthopt) → {google.pubsub.v1.IngestionDataSourceSettings}

Decodes an IngestionDataSourceSettings 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.pubsub.v1.IngestionDataSourceSettings

IngestionDataSourceSettings

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.pubsub.v1.IngestionDataSourceSettings}

Decodes an IngestionDataSourceSettings 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.pubsub.v1.IngestionDataSourceSettings

IngestionDataSourceSettings

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

Parameters:
Name Type Attributes Description
message google.pubsub.v1.IIngestionDataSourceSettings

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

Parameters:
Name Type Attributes Description
message google.pubsub.v1.IIngestionDataSourceSettings

IngestionDataSourceSettings message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.pubsub.v1.IngestionDataSourceSettings}

Creates an IngestionDataSourceSettings 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.pubsub.v1.IngestionDataSourceSettings

IngestionDataSourceSettings

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for IngestionDataSourceSettings

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

Parameters:
Name Type Attributes Description
message google.pubsub.v1.IngestionDataSourceSettings

IngestionDataSourceSettings

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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