fix: Add helper comment for ResourceID validation

apis/bigquerydatatransfer/v1alpha1/config_types.go

@@ -83,6 +83,7 @@ type BigQueryDataTransferConfigSpec struct {
 	Parent `json:",inline"`
 
 	// The BigQueryDataTransferConfig name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Data transfer schedule.

apis/bigquerydatatransfer/v1beta1/transferconfig_types.go

@@ -109,6 +109,7 @@ type BigQueryDataTransferConfigSpec struct {
 	Parent `json:",inline"`
 
 	// The BigQueryDataTransferConfig name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Data transfer schedule.

apis/certificatemanager/v1alpha1/dnsauthorization_types.go

@@ -41,6 +41,7 @@ type CertificateManagerDNSAuthorizationSpec struct {
 	ProjectRef refs.ProjectRef `json:"projectRef"`
 
 	/* Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	// +optional
 	ResourceID *string `json:"resourceID,omitempty"`
 }

apis/certificatemanager/v1beta1/dnsauthorization_types.go

@@ -45,6 +45,7 @@ type CertificateManagerDNSAuthorizationSpec struct {
 	Location string `json:"location"`
 
 	/* Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	// +optional
 	ResourceID *string `json:"resourceID,omitempty"`
 }

apis/compute/v1beta1/targettcpproxy_types.go

@@ -54,6 +54,7 @@ type ComputeTargetTCPProxySpec struct {
 	ProxyHeader *string `json:"proxyHeader,omitempty"`
 
 	// The ComputeTargetTCPProxy name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 }
 

apis/containerattached/v1beta1/cluster_types.go

@@ -30,6 +30,7 @@ type ContainerAttachedClusterSpec struct {
 
 	// Optional.
 	// The ContainerAttachedCluster name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Location field is immutable"

apis/discoveryengine/v1alpha1/discoveryenginedatastore_types.go

@@ -26,6 +26,7 @@ var DiscoveryEngineDataStoreGVK = GroupVersion.WithKind("DiscoveryEngineDataStor
 // +kcc:proto=google.cloud.discoveryengine.v1.DataStore
 type DiscoveryEngineDataStoreSpec struct {
 	// The DiscoveryEngineDataStore name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Required. The data store display name.

apis/kms/v1alpha1/keyhandle_types.go

@@ -30,6 +30,7 @@ type KMSKeyHandleSpec struct {
 	// The KMS Key Handle ID used for resource creation or acquisition.
 	// For creation: If specified, this value is used as the key handle ID. If not provided, a UUID will be generated and assigned as the key handle ID.
 	// For acquisition: This field must be provided to identify the key handle resource to acquire.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Project hosting KMSKeyHandle

apis/kms/v1beta1/keyhandle_types.go

@@ -30,6 +30,7 @@ type KMSKeyHandleSpec struct {
 	// The KMS Key Handle ID used for resource creation or acquisition.
 	// For creation: If specified, this value is used as the key handle ID. If not provided, a UUID will be generated and assigned as the key handle ID.
 	// For acquisition: This field must be provided to identify the key handle resource to acquire.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Project hosting KMSKeyHandle

apis/privilegedaccessmanager/v1alpha1/entitlement_types.go

@@ -50,6 +50,7 @@ type PrivilegedAccessManagerEntitlementSpec struct {
 
 	// The PrivilegedAccessManagerEntitlement name. If not given, the
 	// 'metadata.name' will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	// +optional
 	ResourceID *string `json:"resourceID,omitempty"`
 

apis/privilegedaccessmanager/v1beta1/privilegedaccessmanagerentitlement_types.go

@@ -51,6 +51,7 @@ type PrivilegedAccessManagerEntitlementSpec struct {
 	// Immutable.
 	// The PrivilegedAccessManagerEntitlement name. If not given, the
 	// 'metadata.name' will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	// +optional
 	ResourceID *string `json:"resourceID,omitempty"`
 

apis/secretmanager/v1beta1/secret_types.go

@@ -29,6 +29,7 @@ var SecretManagerSecretGVK = GroupVersion.WithKind("SecretManagerSecret")
 // +kcc:proto=google.cloud.secretmanager.v1.Secret
 type SecretManagerSecretSpec struct {
 	// The SecretManagerSecret name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Immutable. The replication policy of the secret data attached to

apis/securesourcemanager/v1alpha1/repository_types.go

@@ -36,6 +36,7 @@ type SecureSourceManagerRepositorySpec struct {
 	Location string `json:"location"`
 
 	// The SecureSourceManagerRepository name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// The name of the instance in which the repository is hosted, formatted as

apis/spanner/v1beta1/instance_types.go

@@ -46,6 +46,7 @@ type SpannerInstanceSpec struct {
 	ProcessingUnits *int32 `json:"processingUnits,omitempty"`
 
 	// The SpannerInstance name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 }
 

apis/workstations/v1alpha1/cluster_types.go

@@ -37,6 +37,7 @@ type WorkstationClusterSpec struct {
 	Location string `json:"location,omitempty"`
 
 	// The WorkstationCluster name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Human-readable name for this workstation cluster.

apis/workstations/v1alpha1/config_types.go

@@ -275,6 +275,7 @@ type WorkstationConfigSpec struct {
 	Parent *WorkstationClusterRef `json:"parentRef"`
 
 	// The WorkstationConfig name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Human-readable name for this workstation configuration.

apis/workstations/v1alpha1/workstation_types.go

@@ -28,6 +28,7 @@ type WorkstationSpec struct {
 	Parent *WorkstationConfigRef `json:"parentRef"`
 
 	// The Workstation name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Human-readable name for this workstation.

apis/workstations/v1beta1/cluster_types.go

@@ -37,6 +37,7 @@ type WorkstationClusterSpec struct {
 	Location string `json:"location,omitempty"`
 
 	// The WorkstationCluster name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Human-readable name for this workstation cluster.

apis/workstations/v1beta1/config_types.go

@@ -275,6 +275,7 @@ type WorkstationConfigSpec struct {
 	Parent *WorkstationClusterRef `json:"parentRef"`
 
 	// The WorkstationConfig name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Human-readable name for this workstation configuration.

apis/workstations/v1beta1/workstation_types.go

@@ -28,6 +28,7 @@ type WorkstationSpec struct {
 	Parent *WorkstationConfigRef `json:"parentRef"`
 
 	// The Workstation name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string `json:"resourceID,omitempty"`
 
 	// Optional. Human-readable name for this workstation.

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_bigquerydatatransferconfigs.bigquerydatatransfer.cnrm.cloud.google.com.yaml

@@ -233,7 +233,8 @@ spec:
                 type: object
               resourceID:
                 description: The BigQueryDataTransferConfig name. If not given, the
-                  metadata.name will be used.
+                  metadata.name will be used. Cannot be changed after create, except
+                  for updating from empty string to the actual resource ID.
                 type: string
               schedule:
                 description: |-
@@ -619,7 +620,8 @@ spec:
                 type: object
               resourceID:
                 description: The BigQueryDataTransferConfig name. If not given, the
-                  metadata.name will be used.
+                  metadata.name will be used. Cannot be changed after create, except
+                  for updating from empty string to the actual resource ID.
                 type: string
               schedule:
                 description: |-

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_certificatemanagerdnsauthorizations.certificatemanager.cnrm.cloud.google.com.yaml

@@ -109,7 +109,8 @@ spec:
               resourceID:
                 description: Optional. The name of the resource. Used for creation
                   and acquisition. When unset, the value of `metadata.name` is used
-                  as the default.
+                  as the default. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
             required:
             - domain
@@ -269,7 +270,8 @@ spec:
               resourceID:
                 description: Optional. The name of the resource. Used for creation
                   and acquisition. When unset, the value of `metadata.name` is used
-                  as the default.
+                  as the default. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
             required:
             - domain

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_computetargettcpproxies.compute.cnrm.cloud.google.com.yaml

@@ -117,7 +117,8 @@ spec:
                 type: string
               resourceID:
                 description: The ComputeTargetTCPProxy name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
             required:
             - backendServiceRef

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_containerattachedclusters.containerattached.cnrm.cloud.google.com.yaml

@@ -271,7 +271,8 @@ spec:
                 type: object
               resourceID:
                 description: Optional. The ContainerAttachedCluster name. If not given,
-                  the metadata.name will be used.
+                  the metadata.name will be used. Cannot be changed after create,
+                  except for updating from empty string to the actual resource ID.
                 type: string
             required:
             - distribution

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_discoveryenginedatastores.discoveryengine.cnrm.cloud.google.com.yaml

@@ -122,7 +122,8 @@ spec:
                 type: object
               resourceID:
                 description: The DiscoveryEngineDataStore name. If not given, the
-                  metadata.name will be used.
+                  metadata.name will be used. Cannot be changed after create, except
+                  for updating from empty string to the actual resource ID.
                 type: string
               solutionTypes:
                 description: |-

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_kmskeyhandles.kms.cnrm.cloud.google.com.yaml

@@ -100,7 +100,9 @@ spec:
                   acquisition. For creation: If specified, this value is used as the
                   key handle ID. If not provided, a UUID will be generated and assigned
                   as the key handle ID. For acquisition: This field must be provided
-                  to identify the key handle resource to acquire.'
+                  to identify the key handle resource to acquire. Cannot be changed
+                  after create, except for updating from empty string to the actual
+                  resource ID.'
                 type: string
               resourceTypeSelector:
                 description: Indicates the resource type that the resulting [CryptoKey][]
@@ -240,7 +242,9 @@ spec:
                   acquisition. For creation: If specified, this value is used as the
                   key handle ID. If not provided, a UUID will be generated and assigned
                   as the key handle ID. For acquisition: This field must be provided
-                  to identify the key handle resource to acquire.'
+                  to identify the key handle resource to acquire. Cannot be changed
+                  after create, except for updating from empty string to the actual
+                  resource ID.'
                 type: string
               resourceTypeSelector:
                 description: Indicates the resource type that the resulting [CryptoKey][]

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_privilegedaccessmanagerentitlements.privilegedaccessmanager.cnrm.cloud.google.com.yaml

@@ -304,7 +304,8 @@ spec:
                 type: object
               resourceID:
                 description: The PrivilegedAccessManagerEntitlement name. If not given,
-                  the 'metadata.name' will be used.
+                  the 'metadata.name' will be used. Cannot be changed after create,
+                  except for updating from empty string to the actual resource ID.
                 type: string
             required:
             - eligibleUsers
@@ -668,7 +669,9 @@ spec:
                 type: object
               resourceID:
                 description: Immutable. The PrivilegedAccessManagerEntitlement name.
-                  If not given, the 'metadata.name' will be used.
+                  If not given, the 'metadata.name' will be used. Cannot be changed
+                  after create, except for updating from empty string to the actual
+                  resource ID.
                 type: string
             required:
             - eligibleUsers

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_secretmanagersecrets.secretmanager.cnrm.cloud.google.com.yaml

@@ -240,7 +240,8 @@ spec:
                 type: object
               resourceID:
                 description: The SecretManagerSecret name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
               rotation:
                 description: Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1.Secret].

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_securesourcemanagerrepositories.securesourcemanager.cnrm.cloud.google.com.yaml

@@ -269,7 +269,8 @@ spec:
                 type: object
               resourceID:
                 description: The SecureSourceManagerRepository name. If not given,
-                  the metadata.name will be used.
+                  the metadata.name will be used. Cannot be changed after create,
+                  except for updating from empty string to the actual resource ID.
                 type: string
             required:
             - instanceRef

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_spannerinstances.spanner.cnrm.cloud.google.com.yaml

@@ -84,7 +84,8 @@ spec:
                 type: integer
               resourceID:
                 description: The SpannerInstance name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
             required:
             - config

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_workstationclusters.workstations.cnrm.cloud.google.com.yaml

@@ -203,7 +203,8 @@ spec:
                   rule: self == oldSelf
               resourceID:
                 description: The WorkstationCluster name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
               subnetworkRef:
                 description: Immutable. Reference to the Compute Engine subnetwork
@@ -546,7 +547,8 @@ spec:
                   rule: self == oldSelf
               resourceID:
                 description: The WorkstationCluster name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
               subnetworkRef:
                 description: Immutable. Reference to the Compute Engine subnetwork

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_workstationconfigs.workstations.cnrm.cloud.google.com.yaml

@@ -507,7 +507,8 @@ spec:
                 type: array
               resourceID:
                 description: The WorkstationConfig name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
               runningTimeout:
                 description: |-
@@ -1134,7 +1135,8 @@ spec:
                 type: array
               resourceID:
                 description: The WorkstationConfig name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
               runningTimeout:
                 description: |-

config/crds/resources/apiextensions.k8s.io_v1_customresourcedefinition_workstations.workstations.cnrm.cloud.google.com.yaml

@@ -119,7 +119,8 @@ spec:
                 type: object
               resourceID:
                 description: The Workstation name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
             required:
             - parentRef
@@ -308,7 +309,8 @@ spec:
                 type: object
               resourceID:
                 description: The Workstation name. If not given, the metadata.name
-                  will be used.
+                  will be used. Cannot be changed after create, except for updating
+                  from empty string to the actual resource ID.
                 type: string
             required:
             - parentRef

dev/tools/controllerbuilder/template/apis/types.go

@@ -38,6 +38,7 @@ var {{ .Kind }}GVK = GroupVersion.WithKind("{{ .Kind }}")
 {{- end }}
 type {{ .Kind }}Spec struct {
 	// The {{ .Kind }} name. If not given, the metadata.name will be used.
+	// Cannot be changed after create, except for updating from empty string to the actual resource ID.
 	ResourceID *string ` + "`" + `json:"resourceID,omitempty"` + "`" + `
 }
 

scripts/generate-google3-docs/resource-reference/generated/resource-docs/bigquerydatatransfer/bigquerydatatransferconfig.md

@@ -387,7 +387,7 @@ serviceAccountRef:
         </td>
         <td>
             <p><code class="apitype">string</code></p>
-            <p>{% verbatim %}The BigQueryDataTransferConfig name. If not given, the metadata.name will be used.{% endverbatim %}</p>
+            <p>{% verbatim %}The BigQueryDataTransferConfig name. If not given, the metadata.name will be used. Cannot be changed after create, except for updating from empty string to the actual resource ID.{% endverbatim %}</p>
         </td>
     </tr>
     <tr>

scripts/generate-google3-docs/resource-reference/generated/resource-docs/certificatemanager/certificatemanagerdnsauthorization.md

@@ -168,7 +168,7 @@ resourceID: string
         </td>
         <td>
             <p><code class="apitype">string</code></p>
-            <p>{% verbatim %}Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.{% endverbatim %}</p>
+            <p>{% verbatim %}Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. Cannot be changed after create, except for updating from empty string to the actual resource ID.{% endverbatim %}</p>
         </td>
     </tr>
 </tbody>

scripts/generate-google3-docs/resource-reference/generated/resource-docs/compute/computetargettcpproxy.md

@@ -182,7 +182,7 @@ resourceID: string
         </td>
         <td>
             <p><code class="apitype">string</code></p>
-            <p>{% verbatim %}The ComputeTargetTCPProxy name. If not given, the metadata.name will be used.{% endverbatim %}</p>
+            <p>{% verbatim %}The ComputeTargetTCPProxy name. If not given, the metadata.name will be used. Cannot be changed after create, except for updating from empty string to the actual resource ID.{% endverbatim %}</p>
         </td>
     </tr>
 </tbody>