Class protos.google.cloud.maintenance.api.v1.ResourceMaintenance (0.3.0)

Represents a ResourceMaintenance.

Package

@google-cloud/maintenance-api

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.maintenance.api.v1.IResourceMaintenance);

Constructs a new ResourceMaintenance.

Parameter
Name	Description
properties	IResourceMaintenance Properties to set

Properties

annotations

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

ResourceMaintenance annotations.

controls

public controls: google.cloud.maintenance.api.v1.IMaintenanceControl[];

ResourceMaintenance controls.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance createTime.

etag

public etag: string;

ResourceMaintenance etag.

labels

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

ResourceMaintenance labels.

maintenance

public maintenance?: (google.cloud.maintenance.api.v1.ResourceMaintenance.IMaintenance|null);

ResourceMaintenance maintenance.

maintenanceCancelTime

public maintenanceCancelTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance maintenanceCancelTime.

maintenanceEndTime

public maintenanceEndTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance maintenanceEndTime.

maintenanceScheduledEndTime

public maintenanceScheduledEndTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance maintenanceScheduledEndTime.

maintenanceScheduledStartTime

public maintenanceScheduledStartTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance maintenanceScheduledStartTime.

maintenanceStartTime

public maintenanceStartTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance maintenanceStartTime.

name

public name: string;

ResourceMaintenance name.

resource

public resource?: (google.cloud.maintenance.api.v1.ResourceMaintenance.IResource|null);

ResourceMaintenance resource.

state

public state: (google.cloud.maintenance.api.v1.ResourceMaintenance.State|keyof typeof google.cloud.maintenance.api.v1.ResourceMaintenance.State);

ResourceMaintenance state.

uid

public uid: string;

ResourceMaintenance uid.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

ResourceMaintenance updateTime.

userControllable

public userControllable: boolean;

ResourceMaintenance userControllable.

Methods

create(properties)

public static create(properties?: google.cloud.maintenance.api.v1.IResourceMaintenance): google.cloud.maintenance.api.v1.ResourceMaintenance;

Creates a new ResourceMaintenance instance using the specified properties.

Parameter
Name	Description
properties	IResourceMaintenance Properties to set

Returns
Type	Description
ResourceMaintenance	ResourceMaintenance instance

decode(reader, length)

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

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

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.maintenance.api.v1.ResourceMaintenance;

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

Parameter
Name	Description
reader	(Reader|Uint8Array) Reader or buffer to decode from

Returns
Type	Description
ResourceMaintenance	ResourceMaintenance

encode(message, writer)

public static encode(message: google.cloud.maintenance.api.v1.IResourceMaintenance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ResourceMaintenance message. Does not implicitly messages.

Parameters
Name	Description
message	IResourceMaintenance ResourceMaintenance 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.maintenance.api.v1.IResourceMaintenance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
message	IResourceMaintenance ResourceMaintenance 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.maintenance.api.v1.ResourceMaintenance;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ResourceMaintenance

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

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

toObject(message, options)

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

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

Parameters
Name	Description
message	ResourceMaintenance ResourceMaintenance
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 ResourceMaintenance 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