- 2.53.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.6
- 2.4.3
- 2.3.2
public static final class OSPolicy.Resource.ExecResource extends GeneratedMessageV3 implements OSPolicy.Resource.ExecResourceOrBuilderA resource that allows executing scripts on the VM.
The ExecResource has 2 stages: validate and enforce and both stages
accept a script as an argument to execute.
When the ExecResource is applied by the agent, it first executes the
script in the validate stage. The validate stage can signal that the
ExecResource is already in the desired state by returning an exit code
of 100. If the ExecResource is not in the desired state, it should
return an exit code of 101. Any other exit code returned by this stage
is considered an error.
If the ExecResource is not in the desired state based on the exit code
from the validate stage, the agent proceeds to execute the script from
the enforce stage. If the ExecResource is already in the desired
state, the enforce stage will not be run.
Similar to validate stage, the enforce stage should return an exit
code of 100 to indicate that the resource in now in its desired state.
Any other exit code is considered an error.
NOTE: An exit code of 100 was chosen over 0 (and 101 vs 1) to
have an explicit indicator of in desired state, not in desired state
and errors. Because, for example, Powershell will always return an exit
code of 0 unless an exit statement is provided in the script. So, for
reasons of consistency and being explicit, exit codes 100 and 101
were chosen.
Protobuf type google.cloud.osconfig.v1.OSPolicy.Resource.ExecResource
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OSPolicy.Resource.ExecResourceImplements
OSPolicy.Resource.ExecResourceOrBuilderStatic Fields
ENFORCE_FIELD_NUMBER
public static final int ENFORCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
VALIDATE_FIELD_NUMBER
public static final int VALIDATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static OSPolicy.Resource.ExecResource getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static OSPolicy.Resource.ExecResource.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource.Builder | |
newBuilder(OSPolicy.Resource.ExecResource prototype)
public static OSPolicy.Resource.ExecResource.Builder newBuilder(OSPolicy.Resource.ExecResource prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | OSPolicy.Resource.ExecResource |
| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource.Builder | |
parseDelimitedFrom(InputStream input)
public static OSPolicy.Resource.ExecResource parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OSPolicy.Resource.ExecResource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static OSPolicy.Resource.ExecResource parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OSPolicy.Resource.ExecResource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OSPolicy.Resource.ExecResource | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |