Class protos.google.devtools.cloudbuild.v1.GitFileSource (4.1.1)

Represents a GitFileSource.

Package

@google-cloud/cloudbuild

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.cloudbuild.v1.IGitFileSource);

Constructs a new GitFileSource.

Parameter
Name Description
properties IGitFileSource

Properties to set

Properties

enterpriseConfig

public enterpriseConfig?: "githubEnterpriseConfig";

GitFileSource enterpriseConfig.

githubEnterpriseConfig

public githubEnterpriseConfig?: (string|null);

GitFileSource githubEnterpriseConfig.

path

public path: string;

GitFileSource path.

repository

public repository?: (string|null);

GitFileSource repository.

repoType

public repoType: (google.devtools.cloudbuild.v1.GitFileSource.RepoType|keyof typeof google.devtools.cloudbuild.v1.GitFileSource.RepoType);

GitFileSource repoType.

revision

public revision: string;

GitFileSource revision.

source

public source?: "repository";

GitFileSource source.

uri

public uri: string;

GitFileSource uri.

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IGitFileSource): google.devtools.cloudbuild.v1.GitFileSource;

Creates a new GitFileSource instance using the specified properties.

Parameter
Name Description
properties IGitFileSource

Properties to set

Returns
Type Description
GitFileSource

GitFileSource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.devtools.cloudbuild.v1.GitFileSource;

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

GitFileSource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudbuild.v1.GitFileSource;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GitFileSource

GitFileSource

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.IGitFileSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GitFileSource message. Does not implicitly messages.

Parameters
Name Description
message IGitFileSource

GitFileSource 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.devtools.cloudbuild.v1.IGitFileSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGitFileSource

GitFileSource 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.devtools.cloudbuild.v1.GitFileSource;

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

GitFileSource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GitFileSource

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message GitFileSource

GitFileSource

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