Represents a CloudStorage.
Package
@google-cloud/pubsubConstructors
(constructor)(properties)
constructor(properties?: google.pubsub.v1.IngestionDataSourceSettings.ICloudStorage);Constructs a new CloudStorage.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICloudStorage
Properties to set |
Properties
avroFormat
public avroFormat?: (google.pubsub.v1.IngestionDataSourceSettings.CloudStorage.IAvroFormat|null);CloudStorage avroFormat.
bucket
public bucket: string;CloudStorage bucket.
inputFormat
public inputFormat?: ("textFormat"|"avroFormat"|"pubsubAvroFormat");CloudStorage inputFormat.
matchGlob
public matchGlob: string;CloudStorage matchGlob.
minimumObjectCreateTime
public minimumObjectCreateTime?: (google.protobuf.ITimestamp|null);CloudStorage minimumObjectCreateTime.
pubsubAvroFormat
public pubsubAvroFormat?: (google.pubsub.v1.IngestionDataSourceSettings.CloudStorage.IPubSubAvroFormat|null);CloudStorage pubsubAvroFormat.
state
public state: (google.pubsub.v1.IngestionDataSourceSettings.CloudStorage.State|keyof typeof google.pubsub.v1.IngestionDataSourceSettings.CloudStorage.State);CloudStorage state.
textFormat
public textFormat?: (google.pubsub.v1.IngestionDataSourceSettings.CloudStorage.ITextFormat|null);CloudStorage textFormat.
Methods
create(properties)
public static create(properties?: google.pubsub.v1.IngestionDataSourceSettings.ICloudStorage): google.pubsub.v1.IngestionDataSourceSettings.CloudStorage;Creates a new CloudStorage instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICloudStorage
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CloudStorage |
CloudStorage instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.IngestionDataSourceSettings.CloudStorage;Decodes a CloudStorage message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
CloudStorage |
CloudStorage |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.IngestionDataSourceSettings.CloudStorage;Decodes a CloudStorage message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CloudStorage |
CloudStorage |
encode(message, writer)
public static encode(message: google.pubsub.v1.IngestionDataSourceSettings.ICloudStorage, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CloudStorage message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICloudStorage
CloudStorage message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.pubsub.v1.IngestionDataSourceSettings.ICloudStorage, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CloudStorage message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICloudStorage
CloudStorage message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.IngestionDataSourceSettings.CloudStorage;Creates a CloudStorage message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
CloudStorage |
CloudStorage |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CloudStorage
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this CloudStorage to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.pubsub.v1.IngestionDataSourceSettings.CloudStorage, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CloudStorage message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CloudStorage
CloudStorage |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a CloudStorage message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|