Class protos.google.cloud.chronicle.v1.CustomAPISettings (0.10.1)

Represents a CustomAPISettings.

Implements

Package

@google-cloud/chronicle

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.chronicle.v1.ICustomAPISettings);

Constructs a new CustomAPISettings.

Parameter
Name Description
properties ICustomAPISettings

Properties to set

Properties

authentication

public authentication?: ("noAuth"|"basicAuth"|"oauthClientCredentials"|"headerAuth"|"queryAuth");

CustomAPISettings authentication.

baseUrl

public baseUrl: string;

CustomAPISettings baseUrl.

basicAuth

public basicAuth?: (google.cloud.chronicle.v1.IUsernameSecretAuth|null);

CustomAPISettings basicAuth.

headerAuth

public headerAuth?: (google.cloud.chronicle.v1.ICustomAPIHeaderAuth|null);

CustomAPISettings headerAuth.

noAuth

public noAuth?: (google.cloud.chronicle.v1.ICustomAPINoAuth|null);

CustomAPISettings noAuth.

oauthClientCredentials

public oauthClientCredentials?: (google.cloud.chronicle.v1.IOAuthClientCredentials|null);

CustomAPISettings oauthClientCredentials.

pollingFrequency

public pollingFrequency: number;

CustomAPISettings pollingFrequency.

primaryRequest

public primaryRequest?: (google.cloud.chronicle.v1.ICustomAPITransferNode|null);

CustomAPISettings primaryRequest.

queryAuth

public queryAuth?: (google.cloud.chronicle.v1.ICustomAPIQueryAuth|null);

CustomAPISettings queryAuth.

Methods

create(properties)

public static create(properties?: google.cloud.chronicle.v1.ICustomAPISettings): google.cloud.chronicle.v1.CustomAPISettings;

Creates a new CustomAPISettings instance using the specified properties.

Parameter
Name Description
properties ICustomAPISettings

Properties to set

Returns
Type Description
CustomAPISettings

CustomAPISettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.chronicle.v1.CustomAPISettings;

Decodes a CustomAPISettings 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
CustomAPISettings

CustomAPISettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.chronicle.v1.CustomAPISettings;

Decodes a CustomAPISettings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CustomAPISettings

CustomAPISettings

encode(message, writer)

public static encode(message: google.cloud.chronicle.v1.ICustomAPISettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CustomAPISettings message. Does not implicitly messages.

Parameters
Name Description
message ICustomAPISettings

CustomAPISettings 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.cloud.chronicle.v1.ICustomAPISettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICustomAPISettings

CustomAPISettings 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.cloud.chronicle.v1.CustomAPISettings;

Creates a CustomAPISettings 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
CustomAPISettings

CustomAPISettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CustomAPISettings

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CustomAPISettings

CustomAPISettings

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 CustomAPISettings 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