google-api-python-client 2.145.0__py2.py3-none-any.whl → 2.147.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/firebaseml.v2beta.json

@@ -206,7 +206,7 @@
 }
 }
 },
-"revision": "20240902",
+"revision": "20240917",
 "rootUrl": "https://firebaseml.googleapis.com/",
 "schemas": {
 "Date": {
@@ -312,6 +312,11 @@
 "readOnly": true,
 "type": "integer"
 },
+"logprobsResult": {
+"$ref": "GoogleCloudAiplatformV1beta1LogprobsResult",
+"description": "Output only. Log-likelihood scores for the response tokens and top tokens",
+"readOnly": true
+},
 "safetyRatings": {
 "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.",
 "items": {
@@ -406,6 +411,10 @@
 },
 "type": "array"
 },
+"generationConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerationConfig",
+"description": "Optional. Generation config that the model will use to generate the response."
+},
 "instances": {
 "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.",
 "items": {
@@ -573,6 +582,13 @@
 "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig",
 "description": "Optional. Generation config."
 },
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
+"type": "object"
+},
 "safetySettings": {
 "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.",
 "items": {
@@ -610,6 +626,11 @@
 "readOnly": true,
 "type": "array"
 },
+"modelVersion": {
+"description": "Output only. The model version used to generate the response.",
+"readOnly": true,
+"type": "string"
+},
 "promptFeedback": {
 "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback",
 "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.",
@@ -703,6 +724,11 @@
 "format": "float",
 "type": "number"
 },
+"logprobs": {
+"description": "Optional. Logit probabilities.",
+"format": "int32",
+"type": "integer"
+},
 "maxOutputTokens": {
 "description": "Optional. The maximum number of output tokens to generate per message.",
 "format": "int32",
@@ -713,6 +739,10 @@
 "format": "float",
 "type": "number"
 },
+"responseLogprobs": {
+"description": "Optional. If true, export the logprobs results in response.",
+"type": "boolean"
+},
 "responseMimeType": {
 "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
 "type": "string"
@@ -921,6 +951,62 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1LogprobsResult": {
+"description": "Logprobs Result",
+"id": "GoogleCloudAiplatformV1beta1LogprobsResult",
+"properties": {
+"chosenCandidates": {
+"description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate"
+},
+"type": "array"
+},
+"topCandidates": {
+"description": "Length = total number of decoding steps.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1LogprobsResultCandidate": {
+"description": "Candidate for the logprobs token and score.",
+"id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate",
+"properties": {
+"logProbability": {
+"description": "The candidate's log probability.",
+"format": "float",
+"type": "number"
+},
+"token": {
+"description": "The candidate\u2019s token string value.",
+"type": "string"
+},
+"tokenId": {
+"description": "The candidate\u2019s token id value.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": {
+"description": "Candidates with top log probabilities at each decoding step.",
+"id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates",
+"properties": {
+"candidates": {
+"description": "Sorted by log probability in descending order.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1Part": {
 "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
 "id": "GoogleCloudAiplatformV1beta1Part",
@@ -988,14 +1074,16 @@
 "HARM_CATEGORY_HATE_SPEECH",
 "HARM_CATEGORY_DANGEROUS_CONTENT",
 "HARM_CATEGORY_HARASSMENT",
-"HARM_CATEGORY_SEXUALLY_EXPLICIT"
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
 ],
 "enumDescriptions": [
 "The harm category is unspecified.",
 "The harm category is hate speech.",
 "The harm category is dangerous content.",
 "The harm category is harassment.",
-"The harm category is sexually explicit content."
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
 ],
 "readOnly": true,
 "type": "string"
@@ -1064,14 +1152,16 @@
 "HARM_CATEGORY_HATE_SPEECH",
 "HARM_CATEGORY_DANGEROUS_CONTENT",
 "HARM_CATEGORY_HARASSMENT",
-"HARM_CATEGORY_SEXUALLY_EXPLICIT"
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
 ],
 "enumDescriptions": [
 "The harm category is unspecified.",
 "The harm category is hate speech.",
 "The harm category is dangerous content.",
 "The harm category is harassment.",
-"The harm category is sexually explicit content."
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
 ],
 "type": "string"
 },
@@ -1116,6 +1206,13 @@
 "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.",
 "id": "GoogleCloudAiplatformV1beta1Schema",
 "properties": {
+"anyOf": {
+"description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Schema"
+},
+"type": "array"
+},
 "default": {
 "description": "Optional. Default value of the data.",
 "type": "any"
@@ -1198,6 +1295,13 @@
 "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.",
 "type": "object"
 },
+"propertyOrdering": {
+"description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "required": {
 "description": "Optional. Required properties of Type.OBJECT.",
 "items": {
@@ -1285,7 +1389,7 @@
 "id": "GoogleCloudAiplatformV1beta1Tool",
 "properties": {
 "functionDeclarations": {
-"description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.",
+"description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration"
 },

googleapiclient/discovery_cache/documents/firestore.v1.json

@@ -1682,6 +1682,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `database_uid` (supports `=` only)",
+"location": "query",
+"type": "string"
+},
 "parent": {
 "description": "Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.",
 "location": "path",
@@ -1706,7 +1711,7 @@
 }
 }
 },
-"revision": "20240822",
+"revision": "20240904",
 "rootUrl": "https://firestore.googleapis.com/",
 "schemas": {
 "Aggregation": {
@@ -2525,6 +2530,17 @@
 },
 "type": "object"
 },
+"GoogleFirestoreAdminV1BackupSource": {
+"description": "Information about a backup that was used to restore a database.",
+"id": "GoogleFirestoreAdminV1BackupSource",
+"properties": {
+"backup": {
+"description": "The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata": {
 "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.",
 "id": "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata",
@@ -2762,6 +2778,11 @@
 "readOnly": true,
 "type": "string"
 },
+"sourceInfo": {
+"$ref": "GoogleFirestoreAdminV1SourceInfo",
+"description": "Output only. Information about the provenance of this database.",
+"readOnly": true
+},
 "type": {
 "description": "The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.",
 "enum": [
@@ -3521,6 +3542,21 @@
 "properties": {},
 "type": "object"
 },
+"GoogleFirestoreAdminV1SourceInfo": {
+"description": "Information about the provenance of this database.",
+"id": "GoogleFirestoreAdminV1SourceInfo",
+"properties": {
+"backup": {
+"$ref": "GoogleFirestoreAdminV1BackupSource",
+"description": "If set, this database was restored from the specified backup (or a snapshot thereof)."
+},
+"operation": {
+"description": "The associated long-running operation. This field may not be set after the operation has completed. Format: `projects/{project}/databases/{database}/operations/{operation}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleFirestoreAdminV1Stats": {
 "description": "Backup specific statistics.",
 "id": "GoogleFirestoreAdminV1Stats",

googleapiclient/discovery_cache/documents/gkehub.v1alpha.json

@@ -793,6 +793,41 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"generateExclusivityManifest": {
+"description": "GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed. Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub. The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateExclusivityManifest",
+"httpMethod": "GET",
+"id": "gkehub.projects.locations.memberships.generateExclusivityManifest",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"crManifest": {
+"description": "Optional. The YAML manifest of the membership CR retrieved by `kubectl get memberships membership`. Leave empty if the resource does not exist.",
+"location": "query",
+"type": "string"
+},
+"crdManifest": {
+"description": "Optional. The YAML manifest of the membership CRD retrieved by `kubectl get customresourcedefinitions membership`. Leave empty if the resource does not exist.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}:generateExclusivityManifest",
+"response": {
+"$ref": "GenerateExclusivityManifestResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
 "description": "Gets the details of a Membership.",
 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}",
@@ -1063,6 +1098,41 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"validateExclusivity": {
+"description": "ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships:validateExclusivity",
+"httpMethod": "GET",
+"id": "gkehub.projects.locations.memberships.validateExclusivity",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"crManifest": {
+"description": "Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist.",
+"location": "query",
+"type": "string"
+},
+"intendedMembership": {
+"description": "Required. The intended membership name under the `parent`. This method only does validation in anticipation of a CreateMembership call with the same name.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/memberships:validateExclusivity",
+"response": {
+"$ref": "ValidateExclusivityResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -2185,7 +2255,7 @@
 }
 }
 },
-"revision": "20240902",
+"revision": "20240909",
 "rootUrl": "https://gkehub.googleapis.com/",
 "schemas": {
 "AnthosObservabilityFeatureSpec": {
@@ -4351,6 +4421,21 @@
 },
 "type": "object"
 },
+"GenerateExclusivityManifestResponse": {
+"description": "The response of the exclusivity artifacts manifests for the client to apply.",
+"id": "GenerateExclusivityManifestResponse",
+"properties": {
+"crManifest": {
+"description": "The YAML manifest of the membership CR to apply if a new version of the CR is available. Empty if no update needs to be applied.",
+"type": "string"
+},
+"crdManifest": {
+"description": "The YAML manifest of the membership CRD to apply if a newer version of the CRD is available. Empty if no update needs to be applied.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GenerateMembershipRBACRoleBindingYAMLResponse": {
 "description": "Response for GenerateRBACRoleBindingYAML.",
 "id": "GenerateMembershipRBACRoleBindingYAMLResponse",
@@ -7065,6 +7150,17 @@
 },
 "type": "object"
 },
+"ValidateExclusivityResponse": {
+"description": "The response of exclusivity artifacts validation result status.",
+"id": "ValidateExclusivityResponse",
+"properties": {
+"status": {
+"$ref": "GoogleRpcStatus",
+"description": "The validation result. * `OK` means that exclusivity is validated, assuming the manifest produced by GenerateExclusivityManifest is successfully applied. * `ALREADY_EXISTS` means that the Membership CRD is already owned by another Hub. See `status.message` for more information."
+}
+},
+"type": "object"
+},
 "ValidationResult": {
 "description": "ValidationResults are results set by each validator running during ValidateCreateMembership.",
 "id": "ValidationResult",

googleapiclient/discovery_cache/documents/healthcare.v1.json

@@ -4783,7 +4783,7 @@
 }
 }
 },
-"revision": "20240822",
+"revision": "20240910",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "ActivateConsentRequest": {
@@ -5586,7 +5586,7 @@
 },
 "notificationConfig": {
 "$ref": "NotificationConfig",
-"description": "Notification destination for new DICOM instances. Supplied by the client."
+"description": "Optional. Notification destination for new DICOM instances. Supplied by the client."
 },
 "streamConfigs": {
 "description": "Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.",
@@ -5963,15 +5963,15 @@
 "id": "FhirNotificationConfig",
 "properties": {
 "pubsubTopic": {
-"description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).",
+"description": "Optional. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).",
 "type": "string"
 },
 "sendFullResource": {
-"description": "Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.",
+"description": "Optional. Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.",
 "type": "boolean"
 },
 "sendPreviousResourceOnDelete": {
-"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.",
+"description": "Optional. Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.",
 "type": "boolean"
 }
 },
@@ -5996,7 +5996,7 @@
 "type": "string"
 },
 "defaultSearchHandlingStrict": {
-"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.",
+"description": "Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.",
 "type": "boolean"
 },
 "disableReferentialIntegrity": {
@@ -6008,7 +6008,7 @@
 "type": "boolean"
 },
 "enableUpdateCreate": {
-"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.",
+"description": "Optional. Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.",
 "type": "boolean"
 },
 "labels": {
@@ -6028,14 +6028,14 @@
 "description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"."
 },
 "notificationConfigs": {
-"description": "Specifies where and whether to send notifications upon changes to a FHIR store.",
+"description": "Optional. Specifies where and whether to send notifications upon changes to a FHIR store.",
 "items": {
 "$ref": "FhirNotificationConfig"
 },
 "type": "array"
 },
 "streamConfigs": {
-"description": "A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.",
+"description": "Optional. A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.",
 "items": {
 "$ref": "StreamConfig"
 },
@@ -6330,19 +6330,19 @@
 "id": "GoogleCloudHealthcareV1FhirBigQueryDestination",
 "properties": {
 "datasetUri": {
-"description": "BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.",
+"description": "Optional. BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.",
 "type": "string"
 },
 "force": {
-"description": "The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.",
+"description": "Optional. The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.",
 "type": "boolean"
 },
 "schemaConfig": {
 "$ref": "SchemaConfig",
-"description": "The configuration for the exported BigQuery schema."
+"description": "Optional. The configuration for the exported BigQuery schema."
 },
 "writeDisposition": {
-"description": "Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.",
+"description": "Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.",
 "enum": [
 "WRITE_DISPOSITION_UNSPECIFIED",
 "WRITE_EMPTY",
@@ -6442,7 +6442,7 @@
 "id": "Hl7V2NotificationConfig",
 "properties": {
 "filter": {
-"description": "Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId(\"123456\", \"MRN\")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels.\"priority\"=\"high\"`. The operator `:*` can be used to assert the existence of a label. For example, `labels.\"priority\":*`.",
+"description": "Optional. Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId(\"123456\", \"MRN\")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels.\"priority\"=\"high\"`. The operator `:*` can be used to assert the existence of a label. For example, `labels.\"priority\":*`.",
 "type": "string"
 },
 "pubsubTopic": {
@@ -6468,7 +6468,7 @@
 "type": "string"
 },
 "notificationConfigs": {
-"description": "A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client.",
+"description": "Optional. A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client.",
 "items": {
 "$ref": "Hl7V2NotificationConfig"
 },
@@ -6476,10 +6476,10 @@
 },
 "parserConfig": {
 "$ref": "ParserConfig",
-"description": "The configuration for the parser. It determines how the server parses the messages."
+"description": "Optional. The configuration for the parser. It determines how the server parses the messages."
 },
 "rejectDuplicateMessage": {
-"description": "Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection.",
+"description": "Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection.",
 "type": "boolean"
 }
 },
@@ -7177,12 +7177,12 @@
 "id": "ParserConfig",
 "properties": {
 "allowNullHeader": {
-"description": "Determines whether messages with no header are allowed.",
+"description": "Optional. Determines whether messages with no header are allowed.",
 "type": "boolean"
 },
 "schema": {
 "$ref": "SchemaPackage",
-"description": "Schemas used to parse messages in this store, if schematized parsing is desired."
+"description": "Optional. Schemas used to parse messages in this store, if schematized parsing is desired."
 },
 "segmentTerminator": {
 "description": "Byte(s) to use as the segment terminator. If this is unset, '\\r' is used as segment terminator, matching the HL7 version 2 specification.",
@@ -7624,18 +7624,18 @@
 "id": "SchemaPackage",
 "properties": {
 "ignoreMinOccurs": {
-"description": "Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent.",
+"description": "Optional. Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent.",
 "type": "boolean"
 },
 "schemas": {
-"description": "Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message.",
+"description": "Optional. Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message.",
 "items": {
 "$ref": "Hl7SchemaConfig"
 },
 "type": "array"
 },
 "schematizedParsingType": {
-"description": "Determines how messages that fail to parse are handled.",
+"description": "Optional. Determines how messages that fail to parse are handled.",
 "enum": [
 "SCHEMATIZED_PARSING_TYPE_UNSPECIFIED",
 "SOFT_FAIL",
@@ -7649,14 +7649,14 @@
 "type": "string"
 },
 "types": {
-"description": "Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message.",
+"description": "Optional. Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message.",
 "items": {
 "$ref": "Hl7TypesConfig"
 },
 "type": "array"
 },
 "unexpectedSegmentHandling": {
-"description": "Determines how unexpected segments (segments not matched to the schema) are handled.",
+"description": "Optional. Determines how unexpected segments (segments not matched to the schema) are handled.",
 "enum": [
 "UNEXPECTED_SEGMENT_HANDLING_MODE_UNSPECIFIED",
 "FAIL",
@@ -7885,14 +7885,14 @@
 "properties": {
 "bigqueryDestination": {
 "$ref": "GoogleCloudHealthcareV1FhirBigQueryDestination",
-"description": "The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, \"Patient\", \"Observation\". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))."
+"description": "Optional. The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, \"Patient\", \"Observation\". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))."
 },
 "deidentifiedStoreDestination": {
 "$ref": "DeidentifiedStoreDestination",
 "description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))."
 },
 "resourceTypes": {
-"description": "Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.",
+"description": "Optional. Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.",
 "items": {
 "type": "string"
 },