Google Cloud Config Delivery V1 Client - Class FleetPackage (0.2.1)

Reference documentation and code samples for the Google Cloud Config Delivery V1 Client class FleetPackage.

A FleetPackage resource in the Config Delivery API.

A FleetPackage defines a package through which kubernetes configuration is deployed to a fleet of kubernetes clusters.

Generated from protobuf message google.cloud.configdelivery.v1.FleetPackage

Namespace

Google \ Cloud \ ConfigDelivery \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. Name of the FleetPackage . Format is projects/{project}/locations/{location}/fleetPackages/{fleetPackage} . The fleetPackage component must match [a-z][a-z0-9\-]{0,62}

↳ create_time
Google\Protobuf\Timestamp

Output only. Time at which the FleetPackage was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. Most recent time at which the FleetPackage was updated.

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. Labels are attributes that can be set and used by both the user and by Config Delivery. Labels must meet the following constraints: * * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * * All characters must use UTF-8 encoding, and international characters are allowed. * * Keys must start with a lowercase letter or international character. * * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

↳ resource_bundle_selector
FleetPackage\ResourceBundleSelector

Required. Information specifying the source of kubernetes configuration to deploy.

↳ target
FleetPackage\Target

Optional. Configuration to select target clusters to deploy kubernetes configuration to.

↳ rollout_strategy
RolloutStrategy

Optional. The strategy to use to deploy kubernetes configuration to clusters.

↳ variant_selector
FleetPackage\VariantSelector

Required. Information specifying how to map a ResourceBundle variant to a target cluster.

↳ info
FleetPackageInfo

Output only. Information containing the rollout status of the FleetPackage across all the target clusters.

↳ deletion_propagation_policy
int

Optional. Information around how to handle kubernetes resources at the target clusters when the FleetPackage is deleted.

↳ state
int

Optional. The desired state of the fleet package.

getName

Identifier. Name of the FleetPackage . Format is projects/{project}/locations/{location}/fleetPackages/{fleetPackage} .

The fleetPackage component must match [a-z][a-z0-9\-]{0,62}

Returns
Type
Description
string

setName

Identifier. Name of the FleetPackage . Format is projects/{project}/locations/{location}/fleetPackages/{fleetPackage} .

The fleetPackage component must match [a-z][a-z0-9\-]{0,62}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Time at which the FleetPackage was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the FleetPackage was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Most recent time at which the FleetPackage was updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Most recent time at which the FleetPackage was updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. Labels are attributes that can be set and used by both the user and by Config Delivery. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.

  • All characters must use UTF-8 encoding, and international characters are allowed.

  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
Returns
Type
Description

setLabels

Optional. Labels are attributes that can be set and used by both the user and by Config Delivery. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.

  • All characters must use UTF-8 encoding, and international characters are allowed.

  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
Parameter
Name
Description
Returns
Type
Description
$this

getResourceBundleSelector

Required. Information specifying the source of kubernetes configuration to deploy.

Returns
Type
Description

hasResourceBundleSelector

clearResourceBundleSelector

setResourceBundleSelector

Required. Information specifying the source of kubernetes configuration to deploy.

Parameter
Name
Description
Returns
Type
Description
$this

getTarget

Optional. Configuration to select target clusters to deploy kubernetes configuration to.

Returns
Type
Description

hasTarget

clearTarget

setTarget

Optional. Configuration to select target clusters to deploy kubernetes configuration to.

Parameter
Name
Description
Returns
Type
Description
$this

getRolloutStrategy

Optional. The strategy to use to deploy kubernetes configuration to clusters.

Returns
Type
Description

hasRolloutStrategy

clearRolloutStrategy

setRolloutStrategy

Optional. The strategy to use to deploy kubernetes configuration to clusters.

Parameter
Name
Description
Returns
Type
Description
$this

getVariantSelector

Required. Information specifying how to map a ResourceBundle variant to a target cluster.

Returns
Type
Description

hasVariantSelector

clearVariantSelector

setVariantSelector

Required. Information specifying how to map a ResourceBundle variant to a target cluster.

Parameter
Name
Description
Returns
Type
Description
$this

getInfo

Output only. Information containing the rollout status of the FleetPackage across all the target clusters.

Returns
Type
Description

hasInfo

clearInfo

setInfo

Output only. Information containing the rollout status of the FleetPackage across all the target clusters.

Parameter
Name
Description
Returns
Type
Description
$this

getDeletionPropagationPolicy

Optional. Information around how to handle kubernetes resources at the target clusters when the FleetPackage is deleted.

Returns
Type
Description
int

setDeletionPropagationPolicy

Optional. Information around how to handle kubernetes resources at the target clusters when the FleetPackage is deleted.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getState

Optional. The desired state of the fleet package.

Returns
Type
Description
int

setState

Optional. The desired state of the fleet package.

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: