Class FleetPackage (0.1.0)

public final class FleetPackage extends GeneratedMessageV3 implements FleetPackageOrBuilder

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.

Protobuf type google.cloud.configdelivery.v1beta.FleetPackage

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETION_PROPAGATION_POLICY_FIELD_NUMBER

public static final int DELETION_PROPAGATION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

INFO_FIELD_NUMBER

public static final int INFO_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_BUNDLE_SELECTOR_FIELD_NUMBER

public static final int RESOURCE_BUNDLE_SELECTOR_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_STRATEGY_FIELD_NUMBER

public static final int ROLLOUT_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VARIANT_SELECTOR_FIELD_NUMBER

public static final int VARIANT_SELECTOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FleetPackage getDefaultInstance()
Returns
Type Description
FleetPackage

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FleetPackage.Builder newBuilder()
Returns
Type Description
FleetPackage.Builder

newBuilder(FleetPackage prototype)

public static FleetPackage.Builder newBuilder(FleetPackage prototype)
Parameter
Name Description
prototype FleetPackage
Returns
Type Description
FleetPackage.Builder

parseDelimitedFrom(InputStream input)

public static FleetPackage parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FleetPackage
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FleetPackage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FleetPackage
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FleetPackage parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FleetPackage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FleetPackage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FleetPackage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FleetPackage parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FleetPackage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FleetPackage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FleetPackage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FleetPackage parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FleetPackage
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FleetPackage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FleetPackage
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FleetPackage parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FleetPackage
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FleetPackage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FleetPackage
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FleetPackage parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FleetPackage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FleetPackage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FleetPackage
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FleetPackage> parser()
Returns
Type Description
Parser<FleetPackage>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time at which the FleetPackage was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the FleetPackage was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public FleetPackage getDefaultInstanceForType()
Returns
Type Description
FleetPackage

getDeletionPropagationPolicy()

public DeletionPropagationPolicy getDeletionPropagationPolicy()

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

.google.cloud.configdelivery.v1beta.DeletionPropagationPolicy deletion_propagation_policy = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeletionPropagationPolicy

The deletionPropagationPolicy.

getDeletionPropagationPolicyValue()

public int getDeletionPropagationPolicyValue()

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

.google.cloud.configdelivery.v1beta.DeletionPropagationPolicy deletion_propagation_policy = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for deletionPropagationPolicy.

getInfo()

public FleetPackageInfo getInfo()

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

.google.cloud.configdelivery.v1beta.FleetPackageInfo info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FleetPackageInfo

The info.

getInfoOrBuilder()

public FleetPackageInfoOrBuilder getInfoOrBuilder()

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

.google.cloud.configdelivery.v1beta.FleetPackageInfo info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FleetPackageInfoOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<FleetPackage> getParserForType()
Returns
Type Description
Parser<FleetPackage>
Overrides

getResourceBundleSelector()

public FleetPackage.ResourceBundleSelector getResourceBundleSelector()

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

.google.cloud.configdelivery.v1beta.FleetPackage.ResourceBundleSelector resource_bundle_selector = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FleetPackage.ResourceBundleSelector

The resourceBundleSelector.

getResourceBundleSelectorOrBuilder()

public FleetPackage.ResourceBundleSelectorOrBuilder getResourceBundleSelectorOrBuilder()

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

.google.cloud.configdelivery.v1beta.FleetPackage.ResourceBundleSelector resource_bundle_selector = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FleetPackage.ResourceBundleSelectorOrBuilder

getRolloutStrategy()

public RolloutStrategy getRolloutStrategy()

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

.google.cloud.configdelivery.v1beta.RolloutStrategy rollout_strategy = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutStrategy

The rolloutStrategy.

getRolloutStrategyOrBuilder()

public RolloutStrategyOrBuilder getRolloutStrategyOrBuilder()

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

.google.cloud.configdelivery.v1beta.RolloutStrategy rollout_strategy = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutStrategyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public FleetPackage.State getState()

Optional. The desired state of the fleet package.

.google.cloud.configdelivery.v1beta.FleetPackage.State state = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FleetPackage.State

The state.

getStateValue()

public int getStateValue()

Optional. The desired state of the fleet package.

.google.cloud.configdelivery.v1beta.FleetPackage.State state = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTarget()

public FleetPackage.Target getTarget()

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

.google.cloud.configdelivery.v1beta.FleetPackage.Target target = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FleetPackage.Target

The target.

getTargetOrBuilder()

public FleetPackage.TargetOrBuilder getTargetOrBuilder()

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

.google.cloud.configdelivery.v1beta.FleetPackage.Target target = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FleetPackage.TargetOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVariantSelector()

public FleetPackage.VariantSelector getVariantSelector()

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

.google.cloud.configdelivery.v1beta.FleetPackage.VariantSelector variant_selector = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FleetPackage.VariantSelector

The variantSelector.

getVariantSelectorOrBuilder()

public FleetPackage.VariantSelectorOrBuilder getVariantSelectorOrBuilder()

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

.google.cloud.configdelivery.v1beta.FleetPackage.VariantSelector variant_selector = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FleetPackage.VariantSelectorOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time at which the FleetPackage was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasInfo()

public boolean hasInfo()

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

.google.cloud.configdelivery.v1beta.FleetPackageInfo info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the info field is set.

hasResourceBundleSelector()

public boolean hasResourceBundleSelector()

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

.google.cloud.configdelivery.v1beta.FleetPackage.ResourceBundleSelector resource_bundle_selector = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the resourceBundleSelector field is set.

hasRolloutStrategy()

public boolean hasRolloutStrategy()

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

.google.cloud.configdelivery.v1beta.RolloutStrategy rollout_strategy = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rolloutStrategy field is set.

hasTarget()

public boolean hasTarget()

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

.google.cloud.configdelivery.v1beta.FleetPackage.Target target = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the target field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVariantSelector()

public boolean hasVariantSelector()

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

.google.cloud.configdelivery.v1beta.FleetPackage.VariantSelector variant_selector = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the variantSelector field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FleetPackage.Builder newBuilderForType()
Returns
Type Description
FleetPackage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FleetPackage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FleetPackage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FleetPackage.Builder toBuilder()
Returns
Type Description
FleetPackage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException