Class protos.grafeas.v1.SourceContext (5.6.0)

Represents a SourceContext.

Package

@google-cloud/containeranalysis

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.ISourceContext);

Constructs a new SourceContext.

Parameter
Name Description
properties ISourceContext

Properties to set

Properties

cloudRepo

public cloudRepo?: (grafeas.v1.ICloudRepoSourceContext|null);

SourceContext cloudRepo.

context

public context?: ("cloudRepo"|"gerrit"|"git");

SourceContext context.

gerrit

public gerrit?: (grafeas.v1.IGerritSourceContext|null);

SourceContext gerrit.

git

public git?: (grafeas.v1.IGitSourceContext|null);

SourceContext git.

labels

public labels: { [k: string]: string };

SourceContext labels.

Methods

create(properties)

public static create(properties?: grafeas.v1.ISourceContext): grafeas.v1.SourceContext;

Creates a new SourceContext instance using the specified properties.

Parameter
Name Description
properties ISourceContext

Properties to set

Returns
Type Description
SourceContext

SourceContext instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.SourceContext;

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

SourceContext

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.SourceContext;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SourceContext

SourceContext

encode(message, writer)

public static encode(message: grafeas.v1.ISourceContext, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SourceContext message. Does not implicitly messages.

Parameters
Name Description
message ISourceContext

SourceContext 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: grafeas.v1.ISourceContext, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISourceContext

SourceContext 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 }): grafeas.v1.SourceContext;

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

SourceContext

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SourceContext

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

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

JSON object

toObject(message, options)

public static toObject(message: grafeas.v1.SourceContext, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message SourceContext

SourceContext

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