Class protos.google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs (0.8.1)

Represents an AzureEventHubs.

Implements

Package

@google-cloud/pubsub-api

Constructors

(constructor)(properties)

constructor(properties?: google.pubsub.v1.IngestionDataSourceSettings.IAzureEventHubs);

Constructs a new AzureEventHubs.

Parameter
Name Description
properties IAzureEventHubs

Properties to set

Properties

clientId

public clientId: string;

AzureEventHubs clientId.

eventHub

public eventHub: string;

AzureEventHubs eventHub.

gcpServiceAccount

public gcpServiceAccount: string;

AzureEventHubs gcpServiceAccount.

namespace

public namespace: string;

AzureEventHubs namespace.

resourceGroup

public resourceGroup: string;

AzureEventHubs resourceGroup.

state

public state: (google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs.State|keyof typeof google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs.State);

AzureEventHubs state.

subscriptionId

public subscriptionId: string;

AzureEventHubs subscriptionId.

tenantId

public tenantId: string;

AzureEventHubs tenantId.

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IngestionDataSourceSettings.IAzureEventHubs): google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs;

Creates a new AzureEventHubs instance using the specified properties.

Parameter
Name Description
properties IAzureEventHubs

Properties to set

Returns
Type Description
AzureEventHubs

AzureEventHubs instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs;

Decodes an AzureEventHubs 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
AzureEventHubs

AzureEventHubs

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs;

Decodes an AzureEventHubs message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AzureEventHubs

AzureEventHubs

encode(message, writer)

public static encode(message: google.pubsub.v1.IngestionDataSourceSettings.IAzureEventHubs, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AzureEventHubs message. Does not implicitly messages.

Parameters
Name Description
message IAzureEventHubs

AzureEventHubs 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.IAzureEventHubs, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AzureEventHubs message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IAzureEventHubs

AzureEventHubs 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.AzureEventHubs;

Creates an AzureEventHubs 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
AzureEventHubs

AzureEventHubs

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AzureEventHubs

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 AzureEventHubs to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an AzureEventHubs message. Also converts values to other types if specified.

Parameters
Name Description
message AzureEventHubs

AzureEventHubs

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 an AzureEventHubs message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not