- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 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.ExecResourceOrBuilder
A 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.v1alpha.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 |
parseFrom(ByteString data)
public static OSPolicy.Resource.ExecResource parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OSPolicy.Resource.ExecResource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static OSPolicy.Resource.ExecResource parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static OSPolicy.Resource.ExecResource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static OSPolicy.Resource.ExecResource parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OSPolicy.Resource.ExecResource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static OSPolicy.Resource.ExecResource parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static OSPolicy.Resource.ExecResource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<OSPolicy.Resource.ExecResource> parser()
Returns | |
---|---|
Type | Description |
Parser<ExecResource> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public OSPolicy.Resource.ExecResource getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource |
getEnforce()
public OSPolicy.Resource.ExecResource.Exec getEnforce()
What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce.
.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec enforce = 2;
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.Exec | The enforce. |
getEnforceOrBuilder()
public OSPolicy.Resource.ExecResource.ExecOrBuilder getEnforceOrBuilder()
What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce.
.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec enforce = 2;
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.ExecOrBuilder |
getParserForType()
public Parser<OSPolicy.Resource.ExecResource> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<ExecResource> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getValidate()
public OSPolicy.Resource.ExecResource.Exec getValidate()
Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec validate = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.Exec | The validate. |
getValidateOrBuilder()
public OSPolicy.Resource.ExecResource.ExecOrBuilder getValidateOrBuilder()
Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec validate = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.ExecOrBuilder |
hasEnforce()
public boolean hasEnforce()
What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce.
.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec enforce = 2;
Returns | |
---|---|
Type | Description |
boolean | Whether the enforce field is set. |
hasValidate()
public boolean hasValidate()
Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource.Exec validate = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean | Whether the validate field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public OSPolicy.Resource.ExecResource.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected OSPolicy.Resource.ExecResource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public OSPolicy.Resource.ExecResource.Builder toBuilder()
Returns | |
---|---|
Type | Description |
OSPolicy.Resource.ExecResource.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |