Package com.google.cloud.osconfig.v1beta

Interface GuestPolicies.SoftwareRecipeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GuestPolicies.SoftwareRecipe, GuestPolicies.SoftwareRecipe.Builder
Enclosing class:
GuestPolicies
public static interface GuestPolicies.SoftwareRecipeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getVersion

      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:
      The version.

    • getVersionBytes

      com.google.protobuf.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:
      The bytes for version.

    • getArtifactsList

      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;

    • getArtifacts

      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;

    • getArtifactsCount

      int getArtifactsCount()
       Resources available to be used in the steps in the recipe.
      repeated .google.cloud.osconfig.v1beta.SoftwareRecipe.Artifact artifacts = 3;

    • getArtifactsOrBuilderList

      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;

    • getArtifactsOrBuilder

      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;

    • getInstallStepsList

      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;

    • getInstallSteps

      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;

    • getInstallStepsCount

      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;

    • getInstallStepsOrBuilderList

      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;

    • getInstallStepsOrBuilder

      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;

    • getUpdateStepsList

      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;

    • getUpdateSteps

      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;

    • getUpdateStepsCount

      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;

    • getUpdateStepsOrBuilderList

      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;

    • getUpdateStepsOrBuilder

      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;

    • getDesiredStateValue

      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:
      The enum numeric value on the wire for desiredState.

    • getDesiredState

      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:
      The desiredState.