Class protos.google.cloud.dataform.v1.ReleaseConfig (2.1.0)

Represents a ReleaseConfig.

Package

@google-cloud/dataform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataform.v1.IReleaseConfig);

Constructs a new ReleaseConfig.

Parameter
Name Description
properties IReleaseConfig

Properties to set

Properties

_internalMetadata

public _internalMetadata?: "internalMetadata";

ReleaseConfig _internalMetadata.

codeCompilationConfig

public codeCompilationConfig?: (google.cloud.dataform.v1.ICodeCompilationConfig|null);

ReleaseConfig codeCompilationConfig.

cronSchedule

public cronSchedule: string;

ReleaseConfig cronSchedule.

disabled

public disabled: boolean;

ReleaseConfig disabled.

gitCommitish

public gitCommitish: string;

ReleaseConfig gitCommitish.

internalMetadata

public internalMetadata?: (string|null);

ReleaseConfig internalMetadata.

name

public name: string;

ReleaseConfig name.

recentScheduledReleaseRecords

public recentScheduledReleaseRecords: google.cloud.dataform.v1.ReleaseConfig.IScheduledReleaseRecord[];

ReleaseConfig recentScheduledReleaseRecords.

releaseCompilationResult

public releaseCompilationResult: string;

ReleaseConfig releaseCompilationResult.

timeZone

public timeZone: string;

ReleaseConfig timeZone.

Methods

create(properties)

public static create(properties?: google.cloud.dataform.v1.IReleaseConfig): google.cloud.dataform.v1.ReleaseConfig;

Creates a new ReleaseConfig instance using the specified properties.

Parameter
Name Description
properties IReleaseConfig

Properties to set

Returns
Type Description
ReleaseConfig

ReleaseConfig instance

decode(reader, length)

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

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

ReleaseConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ReleaseConfig

ReleaseConfig

encode(message, writer)

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

Encodes the specified ReleaseConfig message. Does not implicitly messages.

Parameters
Name Description
message IReleaseConfig

ReleaseConfig 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.dataform.v1.IReleaseConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IReleaseConfig

ReleaseConfig 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.dataform.v1.ReleaseConfig;

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

ReleaseConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ReleaseConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ReleaseConfig

ReleaseConfig

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