Skip to content

Commit 22dffa8

Browse files
Google APIscopybara-github
authored andcommitted
docs: add examples for kubernetes secret
chore: explicitly set fields to field_behavior optional PiperOrigin-RevId: 703589766
1 parent 5934869 commit 22dffa8

1 file changed

Lines changed: 32 additions & 16 deletions

File tree

google/cloud/orchestration/airflow/service/v1/environments.proto

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,13 @@ message UserWorkloadsSecret {
769769
// pairs, which can contain sensitive values such as a password, a token, or a
770770
// key. The values for all keys have to be base64-encoded strings. For details
771771
// see: https://kubernetes.io/docs/concepts/configuration/secret/
772+
//
773+
// Example:
774+
//
775+
// {
776+
// "example": "ZXhhbXBsZV92YWx1ZQ==",
777+
// "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl"
778+
// }
772779
map<string, string> data = 2 [(google.api.field_behavior) = OPTIONAL];
773780
}
774781

@@ -798,6 +805,13 @@ message UserWorkloadsConfigMap {
798805
// Optional. The "data" field of Kubernetes ConfigMap, organized in key-value
799806
// pairs. For details see:
800807
// https://kubernetes.io/docs/concepts/configuration/configmap/
808+
//
809+
// Example:
810+
//
811+
// {
812+
// "example_key": "example_value",
813+
// "another_key": "another_value"
814+
// }
801815
map<string, string> data = 2 [(google.api.field_behavior) = OPTIONAL];
802816
}
803817

@@ -1064,14 +1078,16 @@ message EnvironmentConfig {
10641078
// composer-1.*.*-airflow-*.*.*.
10651079
int32 node_count = 3;
10661080

1067-
// The configuration settings for software inside the environment.
1068-
SoftwareConfig software_config = 4;
1081+
// Optional. The configuration settings for software inside the environment.
1082+
SoftwareConfig software_config = 4 [(google.api.field_behavior) = OPTIONAL];
10691083

1070-
// The configuration used for the Kubernetes Engine cluster.
1071-
NodeConfig node_config = 5;
1084+
// Optional. The configuration used for the Kubernetes Engine cluster.
1085+
NodeConfig node_config = 5 [(google.api.field_behavior) = OPTIONAL];
10721086

1073-
// The configuration used for the Private IP Cloud Composer environment.
1074-
PrivateEnvironmentConfig private_environment_config = 7;
1087+
// Optional. The configuration used for the Private IP Cloud Composer
1088+
// environment.
1089+
PrivateEnvironmentConfig private_environment_config = 7
1090+
[(google.api.field_behavior) = OPTIONAL];
10751091

10761092
// Optional. The network-level access control policy for the Airflow web
10771093
// server. If unspecified, no network-level access restrictions will be
@@ -1274,7 +1290,7 @@ message SoftwareConfig {
12741290
PLUGINS_ENABLED = 2;
12751291
}
12761292

1277-
// The version of the software running in the environment.
1293+
// Optional. The version of the software running in the environment.
12781294
// This encapsulates both the version of Cloud Composer functionality and the
12791295
// version of Apache Airflow. It must match the regular expression
12801296
// `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`.
@@ -1298,7 +1314,7 @@ message SoftwareConfig {
12981314
// See also [version
12991315
// list](/composer/docs/concepts/versioning/composer-versions) and [versioning
13001316
// overview](/composer/docs/concepts/versioning/composer-versioning-overview).
1301-
string image_version = 1;
1317+
string image_version = 1 [(google.api.field_behavior) = OPTIONAL];
13021318

13031319
// Optional. Apache Airflow configuration properties to override.
13041320
//
@@ -1511,7 +1527,7 @@ message NodeConfig {
15111527
// is provided, `nodeConfig.subnetwork` must also be provided. For
15121528
// [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
15131529
// `nodeConfig.subnetwork`.
1514-
string network = 3;
1530+
string network = 3 [(google.api.field_behavior) = OPTIONAL];
15151531

15161532
// Optional. The Compute Engine subnetwork to be used for machine
15171533
// communications, specified as a
@@ -1522,7 +1538,7 @@ message NodeConfig {
15221538
// If a subnetwork is provided, `nodeConfig.network` must also be provided,
15231539
// and the subnetwork must belong to the enclosing environment's project and
15241540
// location.
1525-
string subnetwork = 4;
1541+
string subnetwork = 4 [(google.api.field_behavior) = OPTIONAL];
15261542

15271543
// Optional. The disk size in GB used for node VMs. Minimum size is 30GB.
15281544
// If unspecified, defaults to 100GB. Cannot be updated.
@@ -1542,7 +1558,7 @@ message NodeConfig {
15421558
// Optional. The Google Cloud Platform Service Account to be used by the node
15431559
// VMs. If a service account is not specified, the "default" Compute Engine
15441560
// service account is used. Cannot be updated.
1545-
string service_account = 7;
1561+
string service_account = 7 [(google.api.field_behavior) = OPTIONAL];
15461562

15471563
// Optional. The list of instance tags applied to all node VMs. Tags are used
15481564
// to identify valid sources or targets for network firewalls. Each tag within
@@ -1911,15 +1927,15 @@ message Environment {
19111927
ERROR = 5;
19121928
}
19131929

1914-
// The resource name of the environment, in the form:
1930+
// Identifier. The resource name of the environment, in the form:
19151931
// "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
19161932
//
19171933
// EnvironmentId must start with a lowercase letter followed by up to 63
19181934
// lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
1919-
string name = 1;
1935+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
19201936

1921-
// Configuration parameters for this environment.
1922-
EnvironmentConfig config = 2;
1937+
// Optional. Configuration parameters for this environment.
1938+
EnvironmentConfig config = 2 [(google.api.field_behavior) = OPTIONAL];
19231939

19241940
// Output only. The UUID (Universally Unique IDentifier) associated with this
19251941
// environment. This value is generated when the environment is created.
@@ -1942,7 +1958,7 @@ message Environment {
19421958
// * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
19431959
// * Both keys and values are additionally constrained to be <= 128 bytes in
19441960
// size.
1945-
map<string, string> labels = 7;
1961+
map<string, string> labels = 7 [(google.api.field_behavior) = OPTIONAL];
19461962

19471963
// Output only. Reserved for future use.
19481964
bool satisfies_pzs = 8 [(google.api.field_behavior) = OUTPUT_ONLY];

0 commit comments

Comments
 (0)