Constructor
new Subscription(propertiesopt)
Constructs a new Subscription.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.analyticshub.v1.ISubscription |
<optional> |
Properties to set |
- Implements:
-
- ISubscription
Classes
Members
creationTime
Subscription creationTime.
dataExchange
Subscription dataExchange.
lastModifyTime
Subscription lastModifyTime.
linkedDatasetMap
Subscription linkedDatasetMap.
listing
Subscription listing.
name
Subscription name.
organizationDisplayName
Subscription organizationDisplayName.
organizationId
Subscription organizationId.
resourceName
Subscription resourceName.
state
Subscription state.
subscriberContact
Subscription subscriberContact.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
STATE_ACTIVE |
number |
STATE_ACTIVE value |
STATE_STALE |
number |
STATE_STALE value |
STATE_INACTIVE |
number |
STATE_INACTIVE value |
Methods
toJSON() → {Object.<string, *>}
Converts this Subscription to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.bigquery.analyticshub.v1.Subscription}
Creates a new Subscription instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.analyticshub.v1.ISubscription |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.analyticshub.v1.Subscription |
Subscription instance |
(static) decode(reader, lengthopt) → {google.cloud.bigquery.analyticshub.v1.Subscription}
Decodes a Subscription 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.bigquery.analyticshub.v1.Subscription |
Subscription |
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.bigquery.analyticshub.v1.Subscription}
Decodes a Subscription 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.bigquery.analyticshub.v1.Subscription |
Subscription |
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 Subscription message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.analyticshub.v1.ISubscription |
Subscription 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 Subscription message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.analyticshub.v1.ISubscription |
Subscription 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.bigquery.analyticshub.v1.Subscription}
Creates a Subscription 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.bigquery.analyticshub.v1.Subscription |
Subscription |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Subscription
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 Subscription message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.analyticshub.v1.Subscription |
Subscription |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Subscription message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|