- 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 GuestPolicies.SoftwareRecipe.Builder extends GeneratedMessageV3.Builder<GuestPolicies.SoftwareRecipe.Builder> implements GuestPolicies.SoftwareRecipeOrBuilderA software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software.
Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package.
Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell.
Updating a software recipe
If a recipe is assigned to an instance and there is a recipe with the same
name but a lower version already installed and the assigned state
of the recipe is UPDATED, then the recipe is updated to
the new version.
Script Working Directories
Each script or execution step is run in its own temporary directory which is deleted after completing the step.
Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GuestPolicies.SoftwareRecipe.BuilderImplements
GuestPolicies.SoftwareRecipeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllArtifacts(Iterable<? extends GuestPolicies.SoftwareRecipe.Artifact> values)
public GuestPolicies.SoftwareRecipe.Builder addAllArtifacts(Iterable<? extends GuestPolicies.SoftwareRecipe.Artifact> values)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.SoftwareRecipe.Artifact> |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addAllInstallSteps(Iterable<? extends GuestPolicies.SoftwareRecipe.Step> values)
public GuestPolicies.SoftwareRecipe.Builder addAllInstallSteps(Iterable<? extends GuestPolicies.SoftwareRecipe.Step> values)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.SoftwareRecipe.Step> |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addAllUpdateSteps(Iterable<? extends GuestPolicies.SoftwareRecipe.Step> values)
public GuestPolicies.SoftwareRecipe.Builder addAllUpdateSteps(Iterable<? extends GuestPolicies.SoftwareRecipe.Step> values)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.SoftwareRecipe.Step> |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addArtifacts(GuestPolicies.SoftwareRecipe.Artifact value)
public GuestPolicies.SoftwareRecipe.Builder addArtifacts(GuestPolicies.SoftwareRecipe.Artifact value)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
value | GuestPolicies.SoftwareRecipe.Artifact |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addArtifacts(GuestPolicies.SoftwareRecipe.Artifact.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder addArtifacts(GuestPolicies.SoftwareRecipe.Artifact.Builder builderForValue)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | GuestPolicies.SoftwareRecipe.Artifact.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact value)
public GuestPolicies.SoftwareRecipe.Builder addArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact value)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestPolicies.SoftwareRecipe.Artifact |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder addArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact.Builder builderForValue)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestPolicies.SoftwareRecipe.Artifact.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addArtifactsBuilder()
public GuestPolicies.SoftwareRecipe.Artifact.Builder addArtifactsBuilder()Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Artifact.Builder | |
addArtifactsBuilder(int index)
public GuestPolicies.SoftwareRecipe.Artifact.Builder addArtifactsBuilder(int index)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Artifact.Builder | |
addInstallSteps(GuestPolicies.SoftwareRecipe.Step value)
public GuestPolicies.SoftwareRecipe.Builder addInstallSteps(GuestPolicies.SoftwareRecipe.Step value)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
value | GuestPolicies.SoftwareRecipe.Step |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addInstallSteps(GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder addInstallSteps(GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | GuestPolicies.SoftwareRecipe.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step value)
public GuestPolicies.SoftwareRecipe.Builder addInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step value)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestPolicies.SoftwareRecipe.Step |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder addInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestPolicies.SoftwareRecipe.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addInstallStepsBuilder()
public GuestPolicies.SoftwareRecipe.Step.Builder addInstallStepsBuilder()Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step.Builder | |
addInstallStepsBuilder(int index)
public GuestPolicies.SoftwareRecipe.Step.Builder addInstallStepsBuilder(int index)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GuestPolicies.SoftwareRecipe.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addUpdateSteps(GuestPolicies.SoftwareRecipe.Step value)
public GuestPolicies.SoftwareRecipe.Builder addUpdateSteps(GuestPolicies.SoftwareRecipe.Step value)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
value | GuestPolicies.SoftwareRecipe.Step |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addUpdateSteps(GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder addUpdateSteps(GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | GuestPolicies.SoftwareRecipe.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step value)
public GuestPolicies.SoftwareRecipe.Builder addUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step value)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestPolicies.SoftwareRecipe.Step |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder addUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestPolicies.SoftwareRecipe.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
addUpdateStepsBuilder()
public GuestPolicies.SoftwareRecipe.Step.Builder addUpdateStepsBuilder()Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step.Builder | |
addUpdateStepsBuilder(int index)
public GuestPolicies.SoftwareRecipe.Step.Builder addUpdateStepsBuilder(int index)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step.Builder | |
build()
public GuestPolicies.SoftwareRecipe build()| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe | |
buildPartial()
public GuestPolicies.SoftwareRecipe buildPartial()| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe | |
clear()
public GuestPolicies.SoftwareRecipe.Builder clear()| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
clearArtifacts()
public GuestPolicies.SoftwareRecipe.Builder clearArtifacts()Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
clearDesiredState()
public GuestPolicies.SoftwareRecipe.Builder clearDesiredState()Default is INSTALLED. The desired state the agent should maintain for this recipe.
INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
.google.cloud.osconfig.v1beta.DesiredState desired_state = 6;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public GuestPolicies.SoftwareRecipe.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
clearInstallSteps()
public GuestPolicies.SoftwareRecipe.Builder clearInstallSteps()Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
clearName()
public GuestPolicies.SoftwareRecipe.Builder clearName()Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance.
Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GuestPolicies.SoftwareRecipe.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
clearUpdateSteps()
public GuestPolicies.SoftwareRecipe.Builder clearUpdateSteps()Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
clearVersion()
public GuestPolicies.SoftwareRecipe.Builder clearVersion()The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
string version = 2;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
clone()
public GuestPolicies.SoftwareRecipe.Builder clone()| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
getArtifacts(int index)
public GuestPolicies.SoftwareRecipe.Artifact getArtifacts(int index)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Artifact | |
getArtifactsBuilder(int index)
public GuestPolicies.SoftwareRecipe.Artifact.Builder getArtifactsBuilder(int index)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Artifact.Builder | |
getArtifactsBuilderList()
public List<GuestPolicies.SoftwareRecipe.Artifact.Builder> getArtifactsBuilderList()Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getArtifactsCount()
public int getArtifactsCount()Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
getArtifactsList()
public List<GuestPolicies.SoftwareRecipe.Artifact> getArtifactsList()Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Returns | |
|---|---|
| Type | Description |
List<Artifact> | |
getArtifactsOrBuilder(int index)
public GuestPolicies.SoftwareRecipe.ArtifactOrBuilder getArtifactsOrBuilder(int index)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.ArtifactOrBuilder | |
getArtifactsOrBuilderList()
public List<? extends GuestPolicies.SoftwareRecipe.ArtifactOrBuilder> getArtifactsOrBuilderList()Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.SoftwareRecipe.ArtifactOrBuilder> | |
getDefaultInstanceForType()
public GuestPolicies.SoftwareRecipe getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDesiredState()
public GuestPolicies.DesiredState getDesiredState()Default is INSTALLED. The desired state the agent should maintain for this recipe.
INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
.google.cloud.osconfig.v1beta.DesiredState desired_state = 6;
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.DesiredState | The desiredState. |
getDesiredStateValue()
public int getDesiredStateValue()Default is INSTALLED. The desired state the agent should maintain for this recipe.
INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
.google.cloud.osconfig.v1beta.DesiredState desired_state = 6;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for desiredState. |
getInstallSteps(int index)
public GuestPolicies.SoftwareRecipe.Step getInstallSteps(int index)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step | |
getInstallStepsBuilder(int index)
public GuestPolicies.SoftwareRecipe.Step.Builder getInstallStepsBuilder(int index)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step.Builder | |
getInstallStepsBuilderList()
public List<GuestPolicies.SoftwareRecipe.Step.Builder> getInstallStepsBuilderList()Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getInstallStepsCount()
public int getInstallStepsCount()Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
getInstallStepsList()
public List<GuestPolicies.SoftwareRecipe.Step> getInstallStepsList()Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Returns | |
|---|---|
| Type | Description |
List<Step> | |
getInstallStepsOrBuilder(int index)
public GuestPolicies.SoftwareRecipe.StepOrBuilder getInstallStepsOrBuilder(int index)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.StepOrBuilder | |
getInstallStepsOrBuilderList()
public List<? extends GuestPolicies.SoftwareRecipe.StepOrBuilder> getInstallStepsOrBuilderList()Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.SoftwareRecipe.StepOrBuilder> | |
getName()
public String getName()Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance.
Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance.
Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getUpdateSteps(int index)
public GuestPolicies.SoftwareRecipe.Step getUpdateSteps(int index)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step | |
getUpdateStepsBuilder(int index)
public GuestPolicies.SoftwareRecipe.Step.Builder getUpdateStepsBuilder(int index)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Step.Builder | |
getUpdateStepsBuilderList()
public List<GuestPolicies.SoftwareRecipe.Step.Builder> getUpdateStepsBuilderList()Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getUpdateStepsCount()
public int getUpdateStepsCount()Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Returns | |
|---|---|
| Type | Description |
int | |
getUpdateStepsList()
public List<GuestPolicies.SoftwareRecipe.Step> getUpdateStepsList()Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Returns | |
|---|---|
| Type | Description |
List<Step> | |
getUpdateStepsOrBuilder(int index)
public GuestPolicies.SoftwareRecipe.StepOrBuilder getUpdateStepsOrBuilder(int index)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.StepOrBuilder | |
getUpdateStepsOrBuilderList()
public List<? extends GuestPolicies.SoftwareRecipe.StepOrBuilder> getUpdateStepsOrBuilderList()Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.osconfig.v1beta.GuestPolicies.SoftwareRecipe.StepOrBuilder> | |
getVersion()
public String getVersion()The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
string version = 2;
| Returns | |
|---|---|
| Type | Description |
String | The version. |
getVersionBytes()
public ByteString getVersionBytes()The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
string version = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for version. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(GuestPolicies.SoftwareRecipe other)
public GuestPolicies.SoftwareRecipe.Builder mergeFrom(GuestPolicies.SoftwareRecipe other)| Parameter | |
|---|---|
| Name | Description |
other | GuestPolicies.SoftwareRecipe |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GuestPolicies.SoftwareRecipe.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public GuestPolicies.SoftwareRecipe.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GuestPolicies.SoftwareRecipe.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
removeArtifacts(int index)
public GuestPolicies.SoftwareRecipe.Builder removeArtifacts(int index)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
removeInstallSteps(int index)
public GuestPolicies.SoftwareRecipe.Builder removeInstallSteps(int index)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
removeUpdateSteps(int index)
public GuestPolicies.SoftwareRecipe.Builder removeUpdateSteps(int index)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact value)
public GuestPolicies.SoftwareRecipe.Builder setArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact value)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestPolicies.SoftwareRecipe.Artifact |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder setArtifacts(int index, GuestPolicies.SoftwareRecipe.Artifact.Builder builderForValue)Resources available to be used in the steps in the recipe.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestPolicies.SoftwareRecipe.Artifact.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setDesiredState(GuestPolicies.DesiredState value)
public GuestPolicies.SoftwareRecipe.Builder setDesiredState(GuestPolicies.DesiredState value)Default is INSTALLED. The desired state the agent should maintain for this recipe.
INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
.google.cloud.osconfig.v1beta.DesiredState desired_state = 6;
| Parameter | |
|---|---|
| Name | Description |
value | GuestPolicies.DesiredStateThe desiredState to set. |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
setDesiredStateValue(int value)
public GuestPolicies.SoftwareRecipe.Builder setDesiredStateValue(int value)Default is INSTALLED. The desired state the agent should maintain for this recipe.
INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
.google.cloud.osconfig.v1beta.DesiredState desired_state = 6;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for desiredState to set. |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public GuestPolicies.SoftwareRecipe.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step value)
public GuestPolicies.SoftwareRecipe.Builder setInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step value)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestPolicies.SoftwareRecipe.Step |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder setInstallSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step install_steps = 4;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestPolicies.SoftwareRecipe.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setName(String value)
public GuestPolicies.SoftwareRecipe.Builder setName(String value)Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance.
Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public GuestPolicies.SoftwareRecipe.Builder setNameBytes(ByteString value)Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance.
Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GuestPolicies.SoftwareRecipe.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final GuestPolicies.SoftwareRecipe.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step value)
public GuestPolicies.SoftwareRecipe.Builder setUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step value)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestPolicies.SoftwareRecipe.Step |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)
public GuestPolicies.SoftwareRecipe.Builder setUpdateSteps(int index, GuestPolicies.SoftwareRecipe.Step.Builder builderForValue)Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Step update_steps = 5;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestPolicies.SoftwareRecipe.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | |
setVersion(String value)
public GuestPolicies.SoftwareRecipe.Builder setVersion(String value)The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
string version = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe version to set. |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |
setVersionBytes(ByteString value)
public GuestPolicies.SoftwareRecipe.Builder setVersionBytes(ByteString value)The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
string version = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for version to set. |
| Returns | |
|---|---|
| Type | Description |
GuestPolicies.SoftwareRecipe.Builder | This builder for chaining. |