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