Represents an Action.
Package
@google-cloud/life-sciencesConstructors
(constructor)(properties)
constructor(properties?: google.cloud.lifesciences.v2beta.IAction);Constructs a new Action.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAction
Properties to set |
Properties
alwaysRun
public alwaysRun: boolean;Action alwaysRun.
blockExternalNetwork
public blockExternalNetwork: boolean;Action blockExternalNetwork.
commands
public commands: string[];Action commands.
containerName
public containerName: string;Action containerName.
credentials
public credentials?: (google.cloud.lifesciences.v2beta.ISecret|null);Action credentials.
disableImagePrefetch
public disableImagePrefetch: boolean;Action disableImagePrefetch.
disableStandardErrorCapture
public disableStandardErrorCapture: boolean;Action disableStandardErrorCapture.
enableFuse
public enableFuse: boolean;Action enableFuse.
encryptedEnvironment
public encryptedEnvironment?: (google.cloud.lifesciences.v2beta.ISecret|null);Action encryptedEnvironment.
entrypoint
public entrypoint: string;Action entrypoint.
environment
public environment: { [k: string]: string };Action environment.
ignoreExitStatus
public ignoreExitStatus: boolean;Action ignoreExitStatus.
imageUri
public imageUri: string;Action imageUri.
labels
public labels: { [k: string]: string };Action labels.
mounts
public mounts: google.cloud.lifesciences.v2beta.IMount[];Action mounts.
pidNamespace
public pidNamespace: string;Action pidNamespace.
portMappings
public portMappings: { [k: string]: number };Action portMappings.
publishExposedPorts
public publishExposedPorts: boolean;Action publishExposedPorts.
runInBackground
public runInBackground: boolean;Action runInBackground.
timeout
public timeout?: (google.protobuf.IDuration|null);Action timeout.
Methods
create(properties)
public static create(properties?: google.cloud.lifesciences.v2beta.IAction): google.cloud.lifesciences.v2beta.Action;Creates a new Action instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAction
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.lifesciences.v2beta.Action | Action instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.lifesciences.v2beta.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.lifesciences.v2beta.Action | Action |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.lifesciences.v2beta.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.lifesciences.v2beta.Action | Action |
encode(message, writer)
public static encode(message: google.cloud.lifesciences.v2beta.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.lifesciences.v2beta.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.lifesciences.v2beta.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.lifesciences.v2beta.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.lifesciences.v2beta.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.lifesciences.v2beta.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) |
|