Represents a PushConfig.
Package
@google-cloud/pubsubConstructors
(constructor)(properties)
constructor(properties?: google.pubsub.v1.IPushConfig);Constructs a new PushConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPushConfig
Properties to set |
Properties
attributes
public attributes: { [k: string]: string };PushConfig attributes.
authenticationMethod
public authenticationMethod?: "oidcToken";PushConfig authenticationMethod.
noWrapper
public noWrapper?: (google.pubsub.v1.PushConfig.INoWrapper|null);PushConfig noWrapper.
oidcToken
public oidcToken?: (google.pubsub.v1.PushConfig.IOidcToken|null);PushConfig oidcToken.
pubsubWrapper
public pubsubWrapper?: (google.pubsub.v1.PushConfig.IPubsubWrapper|null);PushConfig pubsubWrapper.
pushEndpoint
public pushEndpoint: string;PushConfig pushEndpoint.
wrapper
public wrapper?: ("pubsubWrapper"|"noWrapper");PushConfig wrapper.
Methods
create(properties)
public static create(properties?: google.pubsub.v1.IPushConfig): google.pubsub.v1.PushConfig;Creates a new PushConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPushConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
PushConfig | PushConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.PushConfig;Decodes a PushConfig 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 |
PushConfig | PushConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.PushConfig;Decodes a PushConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
PushConfig | PushConfig |
encode(message, writer)
public static encode(message: google.pubsub.v1.IPushConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PushConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPushConfig
PushConfig 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.IPushConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PushConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPushConfig
PushConfig 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.PushConfig;Creates a PushConfig 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 |
PushConfig | PushConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PushConfig
| 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 PushConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.pubsub.v1.PushConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a PushConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
PushConfig
PushConfig |
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 PushConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|