Interface GuestPolicies.SoftwareRecipeOrBuilder (2.45.0)

Version 2.45.0

• 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 interface GuestPolicies.SoftwareRecipeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArtifacts(int index)

public abstract 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

getArtifactsCount()

public abstract 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 abstract 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 abstract 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 abstract 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>

getDesiredState()

public abstract 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 abstract 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 abstract 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

getInstallStepsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getUpdateStepsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.