Class protos.google.cloud.contentwarehouse.v1.Action (0.3.1)

Represents an Action.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contentwarehouse.v1.IAction);

Constructs a new Action.

Parameter

Name	Description
`properties`	`IAction` Properties to set

Properties

accessControl

public accessControl?: (google.cloud.contentwarehouse.v1.IAccessControlAction|null);

Action accessControl.

action

public action?: ("accessControl"|"dataValidation"|"dataUpdate"|"addToFolder"|"publishToPubSub"|"removeFromFolderAction"|"deleteDocumentAction");

Action action.

actionId

public actionId: string;

Action actionId.

addToFolder

public addToFolder?: (google.cloud.contentwarehouse.v1.IAddToFolderAction|null);

Action addToFolder.

dataUpdate

public dataUpdate?: (google.cloud.contentwarehouse.v1.IDataUpdateAction|null);

Action dataUpdate.

dataValidation

public dataValidation?: (google.cloud.contentwarehouse.v1.IDataValidationAction|null);

Action dataValidation.

deleteDocumentAction

public deleteDocumentAction?: (google.cloud.contentwarehouse.v1.IDeleteDocumentAction|null);

Action deleteDocumentAction.

publishToPubSub

public publishToPubSub?: (google.cloud.contentwarehouse.v1.IPublishAction|null);

Action publishToPubSub.

removeFromFolderAction

public removeFromFolderAction?: (google.cloud.contentwarehouse.v1.IRemoveFromFolderAction|null);

Action removeFromFolderAction.

Methods

create(properties)

public static create(properties?: google.cloud.contentwarehouse.v1.IAction): google.cloud.contentwarehouse.v1.Action;

Creates a new Action instance using the specified properties.

Parameter

Name	Description
`properties`	`IAction` Properties to set

Returns

Type	Description
`google.cloud.contentwarehouse.v1.Action`	Action instance

decode(reader, length)

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

Decodes an Action message from the specified reader or buffer.

Parameters

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns

Type	Description
`google.cloud.contentwarehouse.v1.Action`	Action

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.Action;

Decodes an Action message from the specified reader or buffer, length delimited.

Parameter

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
`google.cloud.contentwarehouse.v1.Action`	Action

encode(message, writer)

public static encode(message: google.cloud.contentwarehouse.v1.IAction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Action message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IAction` Action 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.contentwarehouse.v1.IAction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IAction` Action 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.contentwarehouse.v1.Action;

Creates an Action 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
`google.cloud.contentwarehouse.v1.Action`	Action

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Action

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
`message`	`google.cloud.contentwarehouse.v1.Action` Action
`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 an Action 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