Class google.cloud.scheduler.v1.RetryConfig (2.1.1)

Represents a RetryConfig.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.scheduler.v1.IRetryConfig);

Constructs a new RetryConfig.

Parameter
Name Description
properties IRetryConfig

Properties to set

Properties

maxBackoffDuration

public maxBackoffDuration?: (google.protobuf.IDuration|null);

RetryConfig maxBackoffDuration.

Property Value
Type Description
(google.protobuf.IDuration|null)

maxDoublings

public maxDoublings: number;

RetryConfig maxDoublings.

Property Value
Type Description
number

maxRetryDuration

public maxRetryDuration?: (google.protobuf.IDuration|null);

RetryConfig maxRetryDuration.

Property Value
Type Description
(google.protobuf.IDuration|null)

minBackoffDuration

public minBackoffDuration?: (google.protobuf.IDuration|null);

RetryConfig minBackoffDuration.

Property Value
Type Description
(google.protobuf.IDuration|null)

retryCount

public retryCount: number;

RetryConfig retryCount.

Property Value
Type Description
number

Methods

create(properties)

public static create(properties?: google.cloud.scheduler.v1.IRetryConfig): google.cloud.scheduler.v1.RetryConfig;

Creates a new RetryConfig instance using the specified properties.

Parameter
Name Description
properties IRetryConfig

Properties to set
Returns
Type Description
RetryConfig

RetryConfig instance

decode(reader, length)

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

Decodes a RetryConfig message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
RetryConfig

RetryConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
RetryConfig

RetryConfig

encode(message, writer)

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

Encodes the specified RetryConfig message. Does not implicitly verify messages.

Parameters
Name Description
message IRetryConfig

RetryConfig 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.scheduler.v1.IRetryConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRetryConfig

RetryConfig 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.scheduler.v1.RetryConfig;

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

RetryConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this RetryConfig to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RetryConfig

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