databricks-sdk 0.42.0__py3-none-any.whl → 0.44.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of databricks-sdk might be problematic. Click here for more details.

@@ -563,7 +563,9 @@ class ComplianceStandard(Enum):
563
563
  FEDRAMP_IL5 = 'FEDRAMP_IL5'
564
564
  FEDRAMP_MODERATE = 'FEDRAMP_MODERATE'
565
565
  HIPAA = 'HIPAA'
566
+ HITRUST = 'HITRUST'
566
567
  IRAP_PROTECTED = 'IRAP_PROTECTED'
568
+ ISMAP = 'ISMAP'
567
569
  ITAR_EAR = 'ITAR_EAR'
568
570
  NONE = 'NONE'
569
571
  PCI_DSS = 'PCI_DSS'
@@ -3642,9 +3644,15 @@ class UpdateAccountIpAccessEnableRequest:
3642
3644
  setting: AccountIpAccessEnable
3643
3645
 
3644
3646
  field_mask: str
3645
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3646
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3647
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3647
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3648
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3649
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3650
+ as only the entire collection field can be specified. Field names must exactly match the
3651
+ resource field names.
3652
+
3653
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3654
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3655
+ API changes in the future."""
3648
3656
 
3649
3657
  def as_dict(self) -> dict:
3650
3658
  """Serializes the UpdateAccountIpAccessEnableRequest into a dictionary suitable for use as a JSON request body."""
@@ -3680,9 +3688,15 @@ class UpdateAibiDashboardEmbeddingAccessPolicySettingRequest:
3680
3688
  setting: AibiDashboardEmbeddingAccessPolicySetting
3681
3689
 
3682
3690
  field_mask: str
3683
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3684
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3685
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3691
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3692
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3693
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3694
+ as only the entire collection field can be specified. Field names must exactly match the
3695
+ resource field names.
3696
+
3697
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3698
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3699
+ API changes in the future."""
3686
3700
 
3687
3701
  def as_dict(self) -> dict:
3688
3702
  """Serializes the UpdateAibiDashboardEmbeddingAccessPolicySettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -3718,9 +3732,15 @@ class UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest:
3718
3732
  setting: AibiDashboardEmbeddingApprovedDomainsSetting
3719
3733
 
3720
3734
  field_mask: str
3721
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3722
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3723
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3735
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3736
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3737
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3738
+ as only the entire collection field can be specified. Field names must exactly match the
3739
+ resource field names.
3740
+
3741
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3742
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3743
+ API changes in the future."""
3724
3744
 
3725
3745
  def as_dict(self) -> dict:
3726
3746
  """Serializes the UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -3756,9 +3776,15 @@ class UpdateAutomaticClusterUpdateSettingRequest:
3756
3776
  setting: AutomaticClusterUpdateSetting
3757
3777
 
3758
3778
  field_mask: str
3759
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3760
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3761
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3779
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3780
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3781
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3782
+ as only the entire collection field can be specified. Field names must exactly match the
3783
+ resource field names.
3784
+
3785
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3786
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3787
+ API changes in the future."""
3762
3788
 
3763
3789
  def as_dict(self) -> dict:
3764
3790
  """Serializes the UpdateAutomaticClusterUpdateSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -3794,9 +3820,15 @@ class UpdateComplianceSecurityProfileSettingRequest:
3794
3820
  setting: ComplianceSecurityProfileSetting
3795
3821
 
3796
3822
  field_mask: str
3797
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3798
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3799
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3823
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3824
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3825
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3826
+ as only the entire collection field can be specified. Field names must exactly match the
3827
+ resource field names.
3828
+
3829
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3830
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3831
+ API changes in the future."""
3800
3832
 
3801
3833
  def as_dict(self) -> dict:
3802
3834
  """Serializes the UpdateComplianceSecurityProfileSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -3832,9 +3864,15 @@ class UpdateCspEnablementAccountSettingRequest:
3832
3864
  setting: CspEnablementAccountSetting
3833
3865
 
3834
3866
  field_mask: str
3835
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3836
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3837
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3867
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3868
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3869
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3870
+ as only the entire collection field can be specified. Field names must exactly match the
3871
+ resource field names.
3872
+
3873
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3874
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3875
+ API changes in the future."""
3838
3876
 
3839
3877
  def as_dict(self) -> dict:
3840
3878
  """Serializes the UpdateCspEnablementAccountSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -3877,9 +3915,15 @@ class UpdateDefaultNamespaceSettingRequest:
3877
3915
  applies when using Unity Catalog-enabled compute."""
3878
3916
 
3879
3917
  field_mask: str
3880
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3881
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3882
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3918
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3919
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3920
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3921
+ as only the entire collection field can be specified. Field names must exactly match the
3922
+ resource field names.
3923
+
3924
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3925
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3926
+ API changes in the future."""
3883
3927
 
3884
3928
  def as_dict(self) -> dict:
3885
3929
  """Serializes the UpdateDefaultNamespaceSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -3915,9 +3959,15 @@ class UpdateDisableLegacyAccessRequest:
3915
3959
  setting: DisableLegacyAccess
3916
3960
 
3917
3961
  field_mask: str
3918
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3919
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3920
- specify multiple fields in the field mask, use comma as the separator (no space)."""
3962
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
3963
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
3964
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
3965
+ as only the entire collection field can be specified. Field names must exactly match the
3966
+ resource field names.
3967
+
3968
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
3969
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
3970
+ API changes in the future."""
3921
3971
 
3922
3972
  def as_dict(self) -> dict:
3923
3973
  """Serializes the UpdateDisableLegacyAccessRequest into a dictionary suitable for use as a JSON request body."""
@@ -3953,9 +4003,15 @@ class UpdateDisableLegacyDbfsRequest:
3953
4003
  setting: DisableLegacyDbfs
3954
4004
 
3955
4005
  field_mask: str
3956
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3957
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3958
- specify multiple fields in the field mask, use comma as the separator (no space)."""
4006
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
4007
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
4008
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
4009
+ as only the entire collection field can be specified. Field names must exactly match the
4010
+ resource field names.
4011
+
4012
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4013
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
4014
+ API changes in the future."""
3959
4015
 
3960
4016
  def as_dict(self) -> dict:
3961
4017
  """Serializes the UpdateDisableLegacyDbfsRequest into a dictionary suitable for use as a JSON request body."""
@@ -3991,9 +4047,15 @@ class UpdateDisableLegacyFeaturesRequest:
3991
4047
  setting: DisableLegacyFeatures
3992
4048
 
3993
4049
  field_mask: str
3994
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
3995
- the setting payload will be updated. The field mask needs to be supplied as single string. To
3996
- specify multiple fields in the field mask, use comma as the separator (no space)."""
4050
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
4051
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
4052
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
4053
+ as only the entire collection field can be specified. Field names must exactly match the
4054
+ resource field names.
4055
+
4056
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4057
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
4058
+ API changes in the future."""
3997
4059
 
3998
4060
  def as_dict(self) -> dict:
3999
4061
  """Serializes the UpdateDisableLegacyFeaturesRequest into a dictionary suitable for use as a JSON request body."""
@@ -4029,9 +4091,15 @@ class UpdateEnhancedSecurityMonitoringSettingRequest:
4029
4091
  setting: EnhancedSecurityMonitoringSetting
4030
4092
 
4031
4093
  field_mask: str
4032
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
4033
- the setting payload will be updated. The field mask needs to be supplied as single string. To
4034
- specify multiple fields in the field mask, use comma as the separator (no space)."""
4094
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
4095
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
4096
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
4097
+ as only the entire collection field can be specified. Field names must exactly match the
4098
+ resource field names.
4099
+
4100
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4101
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
4102
+ API changes in the future."""
4035
4103
 
4036
4104
  def as_dict(self) -> dict:
4037
4105
  """Serializes the UpdateEnhancedSecurityMonitoringSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -4067,9 +4135,15 @@ class UpdateEsmEnablementAccountSettingRequest:
4067
4135
  setting: EsmEnablementAccountSetting
4068
4136
 
4069
4137
  field_mask: str
4070
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
4071
- the setting payload will be updated. The field mask needs to be supplied as single string. To
4072
- specify multiple fields in the field mask, use comma as the separator (no space)."""
4138
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
4139
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
4140
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
4141
+ as only the entire collection field can be specified. Field names must exactly match the
4142
+ resource field names.
4143
+
4144
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4145
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
4146
+ API changes in the future."""
4073
4147
 
4074
4148
  def as_dict(self) -> dict:
4075
4149
  """Serializes the UpdateEsmEnablementAccountSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -4191,9 +4265,15 @@ class UpdatePersonalComputeSettingRequest:
4191
4265
  setting: PersonalComputeSetting
4192
4266
 
4193
4267
  field_mask: str
4194
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
4195
- the setting payload will be updated. The field mask needs to be supplied as single string. To
4196
- specify multiple fields in the field mask, use comma as the separator (no space)."""
4268
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
4269
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
4270
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
4271
+ as only the entire collection field can be specified. Field names must exactly match the
4272
+ resource field names.
4273
+
4274
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4275
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
4276
+ API changes in the future."""
4197
4277
 
4198
4278
  def as_dict(self) -> dict:
4199
4279
  """Serializes the UpdatePersonalComputeSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -4248,9 +4328,15 @@ class UpdateRestrictWorkspaceAdminsSettingRequest:
4248
4328
  setting: RestrictWorkspaceAdminsSetting
4249
4329
 
4250
4330
  field_mask: str
4251
- """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
4252
- the setting payload will be updated. The field mask needs to be supplied as single string. To
4253
- specify multiple fields in the field mask, use comma as the separator (no space)."""
4331
+ """The field mask must be a single string, with multiple fields separated by commas (no spaces).
4332
+ The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
4333
+ (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
4334
+ as only the entire collection field can be specified. Field names must exactly match the
4335
+ resource field names.
4336
+
4337
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4338
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
4339
+ API changes in the future."""
4254
4340
 
4255
4341
  def as_dict(self) -> dict:
4256
4342
  """Serializes the UpdateRestrictWorkspaceAdminsSettingRequest into a dictionary suitable for use as a JSON request body."""
@@ -4602,9 +4688,15 @@ class AibiDashboardEmbeddingAccessPolicyAPI:
4602
4688
  This should always be set to true for Settings API. Added for AIP compliance.
4603
4689
  :param setting: :class:`AibiDashboardEmbeddingAccessPolicySetting`
4604
4690
  :param field_mask: str
4605
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
4606
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
4607
- multiple fields in the field mask, use comma as the separator (no space).
4691
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
4692
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
4693
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
4694
+ the entire collection field can be specified. Field names must exactly match the resource field
4695
+ names.
4696
+
4697
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4698
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
4699
+ changes in the future.
4608
4700
 
4609
4701
  :returns: :class:`AibiDashboardEmbeddingAccessPolicySetting`
4610
4702
  """
@@ -4692,9 +4784,15 @@ class AibiDashboardEmbeddingApprovedDomainsAPI:
4692
4784
  This should always be set to true for Settings API. Added for AIP compliance.
4693
4785
  :param setting: :class:`AibiDashboardEmbeddingApprovedDomainsSetting`
4694
4786
  :param field_mask: str
4695
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
4696
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
4697
- multiple fields in the field mask, use comma as the separator (no space).
4787
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
4788
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
4789
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
4790
+ the entire collection field can be specified. Field names must exactly match the resource field
4791
+ names.
4792
+
4793
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4794
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
4795
+ changes in the future.
4698
4796
 
4699
4797
  :returns: :class:`AibiDashboardEmbeddingApprovedDomainsSetting`
4700
4798
  """
@@ -4756,9 +4854,15 @@ class AutomaticClusterUpdateAPI:
4756
4854
  This should always be set to true for Settings API. Added for AIP compliance.
4757
4855
  :param setting: :class:`AutomaticClusterUpdateSetting`
4758
4856
  :param field_mask: str
4759
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
4760
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
4761
- multiple fields in the field mask, use comma as the separator (no space).
4857
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
4858
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
4859
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
4860
+ the entire collection field can be specified. Field names must exactly match the resource field
4861
+ names.
4862
+
4863
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4864
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
4865
+ changes in the future.
4762
4866
 
4763
4867
  :returns: :class:`AutomaticClusterUpdateSetting`
4764
4868
  """
@@ -4822,9 +4926,15 @@ class ComplianceSecurityProfileAPI:
4822
4926
  This should always be set to true for Settings API. Added for AIP compliance.
4823
4927
  :param setting: :class:`ComplianceSecurityProfileSetting`
4824
4928
  :param field_mask: str
4825
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
4826
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
4827
- multiple fields in the field mask, use comma as the separator (no space).
4929
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
4930
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
4931
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
4932
+ the entire collection field can be specified. Field names must exactly match the resource field
4933
+ names.
4934
+
4935
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
4936
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
4937
+ changes in the future.
4828
4938
 
4829
4939
  :returns: :class:`ComplianceSecurityProfileSetting`
4830
4940
  """
@@ -4924,9 +5034,15 @@ class CspEnablementAccountAPI:
4924
5034
  This should always be set to true for Settings API. Added for AIP compliance.
4925
5035
  :param setting: :class:`CspEnablementAccountSetting`
4926
5036
  :param field_mask: str
4927
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
4928
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
4929
- multiple fields in the field mask, use comma as the separator (no space).
5037
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5038
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5039
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5040
+ the entire collection field can be specified. Field names must exactly match the resource field
5041
+ names.
5042
+
5043
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5044
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5045
+ changes in the future.
4930
5046
 
4931
5047
  :returns: :class:`CspEnablementAccountSetting`
4932
5048
  """
@@ -5034,9 +5150,15 @@ class DefaultNamespaceAPI:
5034
5150
  restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only
5035
5151
  applies when using Unity Catalog-enabled compute.
5036
5152
  :param field_mask: str
5037
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5038
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5039
- multiple fields in the field mask, use comma as the separator (no space).
5153
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5154
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5155
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5156
+ the entire collection field can be specified. Field names must exactly match the resource field
5157
+ names.
5158
+
5159
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5160
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5161
+ changes in the future.
5040
5162
 
5041
5163
  :returns: :class:`DefaultNamespaceSetting`
5042
5164
  """
@@ -5124,9 +5246,15 @@ class DisableLegacyAccessAPI:
5124
5246
  This should always be set to true for Settings API. Added for AIP compliance.
5125
5247
  :param setting: :class:`DisableLegacyAccess`
5126
5248
  :param field_mask: str
5127
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5128
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5129
- multiple fields in the field mask, use comma as the separator (no space).
5249
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5250
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5251
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5252
+ the entire collection field can be specified. Field names must exactly match the resource field
5253
+ names.
5254
+
5255
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5256
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5257
+ changes in the future.
5130
5258
 
5131
5259
  :returns: :class:`DisableLegacyAccess`
5132
5260
  """
@@ -5209,9 +5337,15 @@ class DisableLegacyDbfsAPI:
5209
5337
  This should always be set to true for Settings API. Added for AIP compliance.
5210
5338
  :param setting: :class:`DisableLegacyDbfs`
5211
5339
  :param field_mask: str
5212
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5213
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5214
- multiple fields in the field mask, use comma as the separator (no space).
5340
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5341
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5342
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5343
+ the entire collection field can be specified. Field names must exactly match the resource field
5344
+ names.
5345
+
5346
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5347
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5348
+ changes in the future.
5215
5349
 
5216
5350
  :returns: :class:`DisableLegacyDbfs`
5217
5351
  """
@@ -5300,9 +5434,15 @@ class DisableLegacyFeaturesAPI:
5300
5434
  This should always be set to true for Settings API. Added for AIP compliance.
5301
5435
  :param setting: :class:`DisableLegacyFeatures`
5302
5436
  :param field_mask: str
5303
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5304
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5305
- multiple fields in the field mask, use comma as the separator (no space).
5437
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5438
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5439
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5440
+ the entire collection field can be specified. Field names must exactly match the resource field
5441
+ names.
5442
+
5443
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5444
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5445
+ changes in the future.
5306
5446
 
5307
5447
  :returns: :class:`DisableLegacyFeatures`
5308
5448
  """
@@ -5389,9 +5529,15 @@ class EnableIpAccessListsAPI:
5389
5529
  This should always be set to true for Settings API. Added for AIP compliance.
5390
5530
  :param setting: :class:`AccountIpAccessEnable`
5391
5531
  :param field_mask: str
5392
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5393
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5394
- multiple fields in the field mask, use comma as the separator (no space).
5532
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5533
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5534
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5535
+ the entire collection field can be specified. Field names must exactly match the resource field
5536
+ names.
5537
+
5538
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5539
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5540
+ changes in the future.
5395
5541
 
5396
5542
  :returns: :class:`AccountIpAccessEnable`
5397
5543
  """
@@ -5458,9 +5604,15 @@ class EnhancedSecurityMonitoringAPI:
5458
5604
  This should always be set to true for Settings API. Added for AIP compliance.
5459
5605
  :param setting: :class:`EnhancedSecurityMonitoringSetting`
5460
5606
  :param field_mask: str
5461
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5462
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5463
- multiple fields in the field mask, use comma as the separator (no space).
5607
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5608
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5609
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5610
+ the entire collection field can be specified. Field names must exactly match the resource field
5611
+ names.
5612
+
5613
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5614
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5615
+ changes in the future.
5464
5616
 
5465
5617
  :returns: :class:`EnhancedSecurityMonitoringSetting`
5466
5618
  """
@@ -5521,9 +5673,15 @@ class EsmEnablementAccountAPI:
5521
5673
  This should always be set to true for Settings API. Added for AIP compliance.
5522
5674
  :param setting: :class:`EsmEnablementAccountSetting`
5523
5675
  :param field_mask: str
5524
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
5525
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
5526
- multiple fields in the field mask, use comma as the separator (no space).
5676
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
5677
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
5678
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
5679
+ the entire collection field can be specified. Field names must exactly match the resource field
5680
+ names.
5681
+
5682
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
5683
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
5684
+ changes in the future.
5527
5685
 
5528
5686
  :returns: :class:`EsmEnablementAccountSetting`
5529
5687
  """
@@ -6153,9 +6311,15 @@ class PersonalComputeAPI:
6153
6311
  This should always be set to true for Settings API. Added for AIP compliance.
6154
6312
  :param setting: :class:`PersonalComputeSetting`
6155
6313
  :param field_mask: str
6156
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
6157
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
6158
- multiple fields in the field mask, use comma as the separator (no space).
6314
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
6315
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
6316
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
6317
+ the entire collection field can be specified. Field names must exactly match the resource field
6318
+ names.
6319
+
6320
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
6321
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
6322
+ changes in the future.
6159
6323
 
6160
6324
  :returns: :class:`PersonalComputeSetting`
6161
6325
  """
@@ -6253,9 +6417,15 @@ class RestrictWorkspaceAdminsAPI:
6253
6417
  This should always be set to true for Settings API. Added for AIP compliance.
6254
6418
  :param setting: :class:`RestrictWorkspaceAdminsSetting`
6255
6419
  :param field_mask: str
6256
- Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
6257
- setting payload will be updated. The field mask needs to be supplied as single string. To specify
6258
- multiple fields in the field mask, use comma as the separator (no space).
6420
+ The field mask must be a single string, with multiple fields separated by commas (no spaces). The
6421
+ field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
6422
+ `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
6423
+ the entire collection field can be specified. Field names must exactly match the resource field
6424
+ names.
6425
+
6426
+ A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
6427
+ fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
6428
+ changes in the future.
6259
6429
 
6260
6430
  :returns: :class:`RestrictWorkspaceAdminsSetting`
6261
6431
  """