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