Constructor
new CloudStorageConfig(propertiesopt)
Constructs a new CloudStorageConfig.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.pubsub.v1.ICloudStorageConfig |
<optional> |
Properties to set |
- Implements:
-
- ICloudStorageConfig
Classes
Members
avroConfig
CloudStorageConfig avroConfig.
bucket
CloudStorageConfig bucket.
filenamePrefix
CloudStorageConfig filenamePrefix.
filenameSuffix
CloudStorageConfig filenameSuffix.
maxBytes
CloudStorageConfig maxBytes.
maxDuration
CloudStorageConfig maxDuration.
outputFormat
CloudStorageConfig outputFormat.
state
CloudStorageConfig state.
textConfig
CloudStorageConfig textConfig.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
ACTIVE |
number |
ACTIVE value |
PERMISSION_DENIED |
number |
PERMISSION_DENIED value |
NOT_FOUND |
number |
NOT_FOUND value |
IN_TRANSIT_LOCATION_RESTRICTION |
number |
IN_TRANSIT_LOCATION_RESTRICTION value |
Methods
toJSON() → {Object.<string, *>}
Converts this CloudStorageConfig to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.pubsub.v1.CloudStorageConfig}
Creates a new CloudStorageConfig instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.pubsub.v1.ICloudStorageConfig |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.CloudStorageConfig |
CloudStorageConfig instance |
(static) decode(reader, lengthopt) → {google.pubsub.v1.CloudStorageConfig}
Decodes a CloudStorageConfig 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.CloudStorageConfig |
CloudStorageConfig |
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.CloudStorageConfig}
Decodes a CloudStorageConfig 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.CloudStorageConfig |
CloudStorageConfig |
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 CloudStorageConfig message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.ICloudStorageConfig |
CloudStorageConfig 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 CloudStorageConfig message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.ICloudStorageConfig |
CloudStorageConfig 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.CloudStorageConfig}
Creates a CloudStorageConfig 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.CloudStorageConfig |
CloudStorageConfig |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CloudStorageConfig
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 CloudStorageConfig message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.CloudStorageConfig |
CloudStorageConfig |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CloudStorageConfig message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|