Represents a ComplianceNote.
Package
@google-cloud/containeranalysisConstructors
(constructor)(properties)
constructor(properties?: grafeas.v1.IComplianceNote);
Constructs a new ComplianceNote.
Name | Description |
properties |
IComplianceNote
Properties to set |
Properties
cisBenchmark
public cisBenchmark?: (grafeas.v1.ComplianceNote.ICisBenchmark|null);
ComplianceNote cisBenchmark.
complianceType
public complianceType?: "cisBenchmark";
ComplianceNote complianceType.
description
public description: string;
ComplianceNote description.
rationale
public rationale: string;
ComplianceNote rationale.
remediation
public remediation: string;
ComplianceNote remediation.
scanInstructions
public scanInstructions: (Uint8Array|string);
ComplianceNote scanInstructions.
title
public title: string;
ComplianceNote title.
version
public version: grafeas.v1.IComplianceVersion[];
ComplianceNote version.
Methods
create(properties)
public static create(properties?: grafeas.v1.IComplianceNote): grafeas.v1.ComplianceNote;
Creates a new ComplianceNote instance using the specified properties.
Name | Description |
properties |
IComplianceNote
Properties to set |
Type | Description |
grafeas.v1.ComplianceNote | ComplianceNote instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.ComplianceNote;
Decodes a ComplianceNote message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
grafeas.v1.ComplianceNote | ComplianceNote |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.ComplianceNote;
Decodes a ComplianceNote message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
grafeas.v1.ComplianceNote | ComplianceNote |
encode(message, writer)
public static encode(message: grafeas.v1.IComplianceNote, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ComplianceNote message. Does not implicitly messages.
Name | Description |
message |
IComplianceNote
ComplianceNote message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: grafeas.v1.IComplianceNote, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ComplianceNote message, length delimited. Does not implicitly messages.
Name | Description |
message |
IComplianceNote
ComplianceNote message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): grafeas.v1.ComplianceNote;
Creates a ComplianceNote message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
grafeas.v1.ComplianceNote | ComplianceNote |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for ComplianceNote
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this ComplianceNote to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: grafeas.v1.ComplianceNote, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a ComplianceNote message. Also converts values to other types if specified.
Name | Description |
message |
grafeas.v1.ComplianceNote
ComplianceNote |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a ComplianceNote message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|