CloudStorage

google.pubsub.v1.IngestionDataSourceSettings. CloudStorage

Represents a CloudStorage.

Constructor

new CloudStorage(propertiesopt)

Constructs a new CloudStorage.

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

Properties to set

Implements:
  • ICloudStorage

Classes

AvroFormat
PubSubAvroFormat
TextFormat

Members

avroFormat

CloudStorage avroFormat.

bucket

CloudStorage bucket.

inputFormat

CloudStorage inputFormat.

matchGlob

CloudStorage matchGlob.

minimumObjectCreateTime

CloudStorage minimumObjectCreateTime.

pubsubAvroFormat

CloudStorage pubsubAvroFormat.

state

CloudStorage state.

textFormat

CloudStorage textFormat.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ACTIVE number

ACTIVE value

CLOUD_STORAGE_PERMISSION_DENIED number

CLOUD_STORAGE_PERMISSION_DENIED value

PUBLISH_PERMISSION_DENIED number

PUBLISH_PERMISSION_DENIED value

BUCKET_NOT_FOUND number

BUCKET_NOT_FOUND value

TOO_MANY_OBJECTS number

TOO_MANY_OBJECTS value

Methods

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

Converts this CloudStorage to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new CloudStorage instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.pubsub.v1.IngestionDataSourceSettings.CloudStorage

CloudStorage instance

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

Decodes a CloudStorage 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.CloudStorage

CloudStorage

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.CloudStorage}

Decodes a CloudStorage 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.CloudStorage

CloudStorage

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

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

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

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

CloudStorage 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.CloudStorage}

Creates a CloudStorage 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.CloudStorage

CloudStorage

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CloudStorage

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

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

CloudStorage

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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