Class OSPolicy.Resource.ExecResource.Builder

public static final class OSPolicy.Resource.ExecResource.Builder extends GeneratedMessageV3.Builder<OSPolicy.Resource.ExecResource.Builder> 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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OSPolicy.Resource.ExecResource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

build()

public OSPolicy.Resource.ExecResource build()
Returns
TypeDescription
OSPolicy.Resource.ExecResource

buildPartial()

public OSPolicy.Resource.ExecResource buildPartial()
Returns
TypeDescription
OSPolicy.Resource.ExecResource

clear()

public OSPolicy.Resource.ExecResource.Builder clear()
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

clearEnforce()

public OSPolicy.Resource.ExecResource.Builder clearEnforce()

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
TypeDescription
OSPolicy.Resource.ExecResource.Builder

clearField(Descriptors.FieldDescriptor field)

public OSPolicy.Resource.ExecResource.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public OSPolicy.Resource.ExecResource.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

clearValidate()

public OSPolicy.Resource.ExecResource.Builder clearValidate()

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
TypeDescription
OSPolicy.Resource.ExecResource.Builder

clone()

public OSPolicy.Resource.ExecResource.Builder clone()
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

getDefaultInstanceForType()

public OSPolicy.Resource.ExecResource getDefaultInstanceForType()
Returns
TypeDescription
OSPolicy.Resource.ExecResource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
OSPolicy.Resource.ExecResource.Exec

The enforce.

getEnforceBuilder()

public OSPolicy.Resource.ExecResource.Exec.Builder getEnforceBuilder()

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
TypeDescription
OSPolicy.Resource.ExecResource.Exec.Builder

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
TypeDescription
OSPolicy.Resource.ExecResource.ExecOrBuilder

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
TypeDescription
OSPolicy.Resource.ExecResource.Exec

The validate.

getValidateBuilder()

public OSPolicy.Resource.ExecResource.Exec.Builder getValidateBuilder()

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
TypeDescription
OSPolicy.Resource.ExecResource.Exec.Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the validate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEnforce(OSPolicy.Resource.ExecResource.Exec value)

public OSPolicy.Resource.ExecResource.Builder mergeEnforce(OSPolicy.Resource.ExecResource.Exec value)

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;

Parameter
NameDescription
valueOSPolicy.Resource.ExecResource.Exec
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder

mergeFrom(OSPolicy.Resource.ExecResource other)

public OSPolicy.Resource.ExecResource.Builder mergeFrom(OSPolicy.Resource.ExecResource other)
Parameter
NameDescription
otherOSPolicy.Resource.ExecResource
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OSPolicy.Resource.ExecResource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public OSPolicy.Resource.ExecResource.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OSPolicy.Resource.ExecResource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

mergeValidate(OSPolicy.Resource.ExecResource.Exec value)

public OSPolicy.Resource.ExecResource.Builder mergeValidate(OSPolicy.Resource.ExecResource.Exec value)

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];

Parameter
NameDescription
valueOSPolicy.Resource.ExecResource.Exec
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder

setEnforce(OSPolicy.Resource.ExecResource.Exec value)

public OSPolicy.Resource.ExecResource.Builder setEnforce(OSPolicy.Resource.ExecResource.Exec value)

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;

Parameter
NameDescription
valueOSPolicy.Resource.ExecResource.Exec
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder

setEnforce(OSPolicy.Resource.ExecResource.Exec.Builder builderForValue)

public OSPolicy.Resource.ExecResource.Builder setEnforce(OSPolicy.Resource.ExecResource.Exec.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueOSPolicy.Resource.ExecResource.Exec.Builder
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public OSPolicy.Resource.ExecResource.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OSPolicy.Resource.ExecResource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OSPolicy.Resource.ExecResource.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder
Overrides

setValidate(OSPolicy.Resource.ExecResource.Exec value)

public OSPolicy.Resource.ExecResource.Builder setValidate(OSPolicy.Resource.ExecResource.Exec value)

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];

Parameter
NameDescription
valueOSPolicy.Resource.ExecResource.Exec
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder

setValidate(OSPolicy.Resource.ExecResource.Exec.Builder builderForValue)

public OSPolicy.Resource.ExecResource.Builder setValidate(OSPolicy.Resource.ExecResource.Exec.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueOSPolicy.Resource.ExecResource.Exec.Builder
Returns
TypeDescription
OSPolicy.Resource.ExecResource.Builder