Class protos.google.devtools.artifactregistry.v1.CleanupPolicy (3.1.1)

Represents a CleanupPolicy.

Package

@google-cloud/artifact-registry

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.artifactregistry.v1.ICleanupPolicy);

Constructs a new CleanupPolicy.

Parameter
NameDescription
properties ICleanupPolicy

Properties to set

Properties

action

public action: (google.devtools.artifactregistry.v1.CleanupPolicy.Action|keyof typeof google.devtools.artifactregistry.v1.CleanupPolicy.Action);

CleanupPolicy action.

condition

public condition?: (google.devtools.artifactregistry.v1.ICleanupPolicyCondition|null);

CleanupPolicy condition.

conditionType

public conditionType?: ("condition"|"mostRecentVersions");

CleanupPolicy conditionType.

id

public id: string;

CleanupPolicy id.

mostRecentVersions

public mostRecentVersions?: (google.devtools.artifactregistry.v1.ICleanupPolicyMostRecentVersions|null);

CleanupPolicy mostRecentVersions.

Methods

create(properties)

public static create(properties?: google.devtools.artifactregistry.v1.ICleanupPolicy): google.devtools.artifactregistry.v1.CleanupPolicy;

Creates a new CleanupPolicy instance using the specified properties.

Parameter
NameDescription
properties ICleanupPolicy

Properties to set

Returns
TypeDescription
CleanupPolicy

CleanupPolicy instance

decode(reader, length)

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

Decodes a CleanupPolicy message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
CleanupPolicy

CleanupPolicy

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CleanupPolicy

CleanupPolicy

encode(message, writer)

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

Encodes the specified CleanupPolicy message. Does not implicitly messages.

Parameters
NameDescription
message ICleanupPolicy

CleanupPolicy message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.devtools.artifactregistry.v1.ICleanupPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICleanupPolicy

CleanupPolicy message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.devtools.artifactregistry.v1.CleanupPolicy;

Creates a CleanupPolicy message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
CleanupPolicy

CleanupPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CleanupPolicy

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this CleanupPolicy to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message CleanupPolicy

CleanupPolicy

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CleanupPolicy message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not