diff --git a/admin/directory/v1/admin-api.json b/admin/directory/v1/admin-api.json index 7274f7b78bb..72c6d2e5100 100644 --- a/admin/directory/v1/admin-api.json +++ b/admin/directory/v1/admin-api.json @@ -1659,7 +1659,7 @@ "type": "string" }, "query": { - "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups", + "description": "Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).", "location": "query", "type": "string" }, @@ -2896,7 +2896,7 @@ "type": "string" }, "query": { - "description": "String query used to filter results. Should be of the form \"field operator value\" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.", + "description": "String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.", "location": "query", "type": "string" } @@ -4298,7 +4298,7 @@ "type": "string" }, "query": { - "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users", + "description": "Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).", "location": "query", "type": "string" }, @@ -4671,7 +4671,7 @@ } } }, - "revision": "20250916", + "revision": "20250930", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/admin/directory/v1/admin-gen.go b/admin/directory/v1/admin-gen.go index 869fdd1e5b7..4a9250119ce 100644 --- a/admin/directory/v1/admin-gen.go +++ b/admin/directory/v1/admin-gen.go @@ -10237,9 +10237,10 @@ func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall { return c } -// Query sets the optional parameter "query": Query string search. Should be of -// the form "". Complete documentation is at -// https://developers.google.com/workspace/admin/directory/v1/guides/search-groups +// Query sets the optional parameter "query": Query string search. Contains one +// or more search clauses, each with a field, operator, and value. For complete +// documentation, go to Search for groups +// (https://developers.google.com/workspace/admin/directory/v1/guides/search-groups). func (c *GroupsListCall) Query(query string) *GroupsListCall { c.urlParams_.Set("query", query) return c @@ -14059,13 +14060,13 @@ func (c *ResourcesCalendarsListCall) PageToken(pageToken string) *ResourcesCalen } // Query sets the optional parameter "query": String query used to filter -// results. Should be of the form "field operator value" where field can be any -// of supported fields and operators can be any of supported operations. -// Operators include '=' for exact match, '!=' for mismatch and ':' for prefix -// match or HAS match where applicable. For prefix match, the value should -// always be followed by a *. Logical operators NOT and AND are supported (in -// this order of precedence). Supported fields include `generatedResourceName`, -// `name`, `buildingId`, `floor_name`, `capacity`, +// results. Contains one or more search clauses, each with a field, operator, +// and value. A field can be any of supported fields and operators can be any +// of supported operations. Operators include '=' for exact match, '!=' for +// mismatch and ':' for prefix match or HAS match where applicable. For prefix +// match, the value should always be followed by a *. Logical operators NOT and +// AND are supported (in this order of precedence). Supported fields include +// `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, // `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For // example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. func (c *ResourcesCalendarsListCall) Query(query string) *ResourcesCalendarsListCall { @@ -18456,9 +18457,10 @@ func (c *UsersWatchCall) Projection(projection string) *UsersWatchCall { return c } -// Query sets the optional parameter "query": Query string search. Should be of -// the form "". Complete documentation is at -// https://developers.google.com/workspace/admin/directory/v1/guides/search-users +// Query sets the optional parameter "query": Query string search. Contains one +// or more search clauses, each with a field, operator, and value. For complete +// documentation, go to Search for users +// (https://developers.google.com/workspace/admin/directory/v1/guides/search-users). func (c *UsersWatchCall) Query(query string) *UsersWatchCall { c.urlParams_.Set("query", query) return c diff --git a/alloydb/v1/alloydb-api.json b/alloydb/v1/alloydb-api.json index 615fcf2be74..6a5348534d2 100644 --- a/alloydb/v1/alloydb-api.json +++ b/alloydb/v1/alloydb-api.json @@ -1550,6 +1550,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1622,7 +1627,7 @@ } } }, - "revision": "20250910", + "revision": "20250925", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1636,6 +1641,24 @@ }, "type": "object" }, + "AutoScalingConfig": { + "description": "Configuration for autoscaling.", + "id": "AutoScalingConfig", + "properties": { + "policy": { + "$ref": "Policy", + "description": "Policy for the MIG autoscaler." + }, + "schedules": { + "description": "Optional list of schedules for the MIG autoscaler. If not set, no schedules are created.", + "items": { + "$ref": "Schedule" + }, + "type": "array" + } + }, + "type": "object" + }, "AutomatedBackupPolicy": { "description": "Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.", "id": "AutomatedBackupPolicy", @@ -1862,6 +1885,99 @@ }, "type": "object" }, + "BackupDrBackupSource": { + "description": "Message describing a BackupDrBackupSource.", + "id": "BackupDrBackupSource", + "properties": { + "backup": { + "description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}", + "type": "string" + } + }, + "type": "object" + }, + "BackupDrEnabledWindow": { + "description": "Information about a single window when BackupDR was enabled for this cluster.", + "id": "BackupDrEnabledWindow", + "properties": { + "automatedBackupPreviouslyEnabled": { + "description": "Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster.", + "type": "boolean" + }, + "backupPlanAssociation": { + "description": "The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster.", + "type": "string" + }, + "continuousBackupPreviousRecoveryWindowDays": { + "description": "The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster.", + "format": "int32", + "type": "integer" + }, + "continuousBackupPreviouslyEnabled": { + "description": "Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", + "type": "boolean" + }, + "continuousBackupPreviouslyEnabledTime": { + "description": "The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.", + "format": "google-datetime", + "type": "string" + }, + "dataSource": { + "description": "The DataSource resource that represents the cluster in BackupDR.", + "type": "string" + }, + "disabledTime": { + "description": "Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`.", + "format": "google-datetime", + "type": "string" + }, + "enabledTime": { + "description": "Time when the BackupDR protection for this cluster was enabled.", + "format": "google-datetime", + "type": "string" + }, + "logRetentionPeriod": { + "description": "The retention period for logs generated by BackupDR for this cluster.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "BackupDrInfo": { + "description": "Information about BackupDR protection for this cluster.", + "id": "BackupDrInfo", + "properties": { + "currentWindow": { + "$ref": "BackupDrEnabledWindow", + "description": "The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty." + }, + "previousWindows": { + "description": "Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list.", + "items": { + "$ref": "BackupDrEnabledWindow" + }, + "type": "array" + } + }, + "type": "object" + }, + "BackupDrPitrSource": { + "description": "Message describing a BackupDrPitrSource.", + "id": "BackupDrPitrSource", + "properties": { + "dataSource": { + "description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}", + "type": "string" + }, + "pointInTime": { + "description": "Required. The point in time to restore to.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "BackupSource": { "description": "Message describing a BackupSource.", "id": "BackupSource", @@ -1970,6 +2086,16 @@ "description": "Output only. Cluster created from backup.", "readOnly": true }, + "backupdrBackupSource": { + "$ref": "BackupDrBackupSource", + "description": "Output only. Cluster created from a BackupDR backup.", + "readOnly": true + }, + "backupdrInfo": { + "$ref": "BackupDrInfo", + "description": "Output only. Output only information about BackupDR protection for this cluster.", + "readOnly": true + }, "cloudsqlBackupRunSource": { "$ref": "CloudSQLBackupRunSource", "description": "Output only. Cluster created from CloudSQL snapshot.", @@ -2420,6 +2546,18 @@ }, "type": "object" }, + "CpuUtilization": { + "description": "CPU utilization policy for the autoscaler.", + "id": "CpuUtilization", + "properties": { + "utilizationTarget": { + "description": "Target CPU utilization as a float between 0 and 1.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "CsvExportOptions": { "description": "Options for exporting data in CSV format.", "id": "CsvExportOptions", @@ -3166,6 +3304,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3496,6 +3641,31 @@ }, "type": "object" }, + "Policy": { + "description": "Policy for the autoscaler.", + "id": "Policy", + "properties": { + "coolDownPeriodSec": { + "description": "The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm.", + "format": "int64", + "type": "string" + }, + "cpuUtilization": { + "$ref": "CpuUtilization", + "description": "CPU utilization policy for the autoscaler." + }, + "enabled": { + "description": "If true, autoscaling is enabled for the instance. If not set, the default value is false.", + "type": "boolean" + }, + "maxNodeCount": { + "description": "Maximum number of nodes for the autoscaler.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "PrimaryConfig": { "description": "Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.", "id": "PrimaryConfig", @@ -3686,6 +3856,10 @@ "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", "properties": { + "autoScalingConfig": { + "$ref": "AutoScalingConfig", + "description": "Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled." + }, "nodeCount": { "description": "Read capacity, i.e. number of nodes in a read pool instance.", "format": "int32", @@ -3734,6 +3908,14 @@ "$ref": "BackupSource", "description": "Backup source." }, + "backupdrBackupSource": { + "$ref": "BackupDrBackupSource", + "description": "BackupDR backup source." + }, + "backupdrPitrSource": { + "$ref": "BackupDrPitrSource", + "description": "BackupDR source used for point in time recovery." + }, "cluster": { "$ref": "Cluster", "description": "Required. The resource being created" @@ -3776,6 +3958,43 @@ }, "type": "object" }, + "Schedule": { + "description": "A schedule for the autoscaler.", + "id": "Schedule", + "properties": { + "cronExpression": { + "description": "Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax.", + "type": "string" + }, + "description": { + "description": "Description of the schedule.", + "type": "string" + }, + "disabled": { + "description": "If true, the schedule is disabled.", + "type": "boolean" + }, + "durationSec": { + "description": "Duration of the schedule.", + "format": "int64", + "type": "string" + }, + "minNodeCount": { + "description": "Minimum number of nodes in while the schedule is active.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of the schedule.", + "type": "string" + }, + "timeZone": { + "description": "The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default.", + "type": "string" + } + }, + "type": "object" + }, "SecondaryConfig": { "description": "Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.", "id": "SecondaryConfig", @@ -3925,33 +4144,6 @@ }, "type": "object" }, - "StageSchedule": { - "description": "Timing information for the stage execution.", - "id": "StageSchedule", - "properties": { - "actualEndTime": { - "description": "Actual end time of the stage. Set only if the stage has completed.", - "format": "google-datetime", - "type": "string" - }, - "actualStartTime": { - "description": "Actual start time of the stage. Set only if the stage has started.", - "format": "google-datetime", - "type": "string" - }, - "estimatedEndTime": { - "description": "When the stage is expected to end. Set only if the stage has not completed yet.", - "format": "google-datetime", - "type": "string" - }, - "estimatedStartTime": { - "description": "When the stage is expected to start. Set only if the stage has not started yet.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "StageStatus": { "description": "Status of an upgrade stage.", "id": "StageStatus", @@ -3960,11 +4152,6 @@ "$ref": "ReadPoolInstancesUpgradeStageStatus", "description": "Read pool instances upgrade metadata." }, - "schedule": { - "$ref": "StageSchedule", - "description": "Output only. Timing information for the stage execution.", - "readOnly": true - }, "stage": { "description": "Upgrade stage.", "enum": [ @@ -4836,7 +5023,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata. Next ID: 27", + "description": "Common model for database resource instance metadata. Next ID: 29", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4987,6 +5174,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "description": "Machine configuration for this resource." }, + "maintenanceInfo": { + "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", + "description": "Optional. Maintenance info for the resource." + }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -5692,6 +5883,100 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule": { + "description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", + "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Optional. Deny period end date." + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Optional. The start date of the deny maintenance period." + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." + } + }, + "type": "object" + }, + "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo": { + "description": "MaintenanceInfo to capture the maintenance details of database resource.", + "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo", + "properties": { + "denyMaintenanceSchedules": { + "description": "Optional. List of Deny maintenance period for the database resource.", + "items": { + "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule" + }, + "type": "array" + }, + "maintenanceSchedule": { + "$ref": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", + "description": "Optional. Maintenance window for the database resource." + }, + "maintenanceVersion": { + "description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", + "type": "string" + } + }, + "type": "object" + }, + "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule": { + "description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", + "id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule", + "properties": { + "day": { + "description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "phase": { + "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", + "enum": [ + "WINDOW_PHASE_UNSPECIFIED", + "WINDOW_PHASE_ANY", + "WINDOW_PHASE_WEEK1", + "WINDOW_PHASE_WEEK2", + "WINDOW_PHASE_WEEK5" + ], + "enumDescriptions": [ + "Phase is unspecified.", + "Any phase.", + "Week 1.", + "Week 2.", + "Week 5." + ], + "type": "string" + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Optional. Preferred time to start the maintenance operation on the specified day." + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { diff --git a/alloydb/v1/alloydb-gen.go b/alloydb/v1/alloydb-gen.go index a0d0fc39500..3c1d3e297e5 100644 --- a/alloydb/v1/alloydb-gen.go +++ b/alloydb/v1/alloydb-gen.go @@ -270,6 +270,31 @@ func (s AuthorizedNetwork) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// AutoScalingConfig: Configuration for autoscaling. +type AutoScalingConfig struct { + // Policy: Policy for the MIG autoscaler. + Policy *Policy `json:"policy,omitempty"` + // Schedules: Optional list of schedules for the MIG autoscaler. If not set, no + // schedules are created. + Schedules []*Schedule `json:"schedules,omitempty"` + // ForceSendFields is a list of field names (e.g. "Policy") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Policy") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s AutoScalingConfig) MarshalJSON() ([]byte, error) { + type NoMethod AutoScalingConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // AutomatedBackupPolicy: Message describing the user-specified automated // backup policy. All fields in the automated backup policy are optional. // Defaults for each field are provided if they are not set. @@ -442,6 +467,136 @@ func (s Backup) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// BackupDrBackupSource: Message describing a BackupDrBackupSource. +type BackupDrBackupSource struct { + // Backup: Required. The name of the backup resource with the format: * + // projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSou + // rces/{datasource_id}/backups/{backup_id} + Backup string `json:"backup,omitempty"` + // ForceSendFields is a list of field names (e.g. "Backup") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Backup") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s BackupDrBackupSource) MarshalJSON() ([]byte, error) { + type NoMethod BackupDrBackupSource + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// BackupDrEnabledWindow: Information about a single window when BackupDR was +// enabled for this cluster. +type BackupDrEnabledWindow struct { + // AutomatedBackupPreviouslyEnabled: Whether automated backup was previously + // enabled prior to enabling BackupDR protection for this cluster. + AutomatedBackupPreviouslyEnabled bool `json:"automatedBackupPreviouslyEnabled,omitempty"` + // BackupPlanAssociation: The BackupPlanAssociation resource that was used to + // enable BackupDR protection for this cluster. + BackupPlanAssociation string `json:"backupPlanAssociation,omitempty"` + // ContinuousBackupPreviousRecoveryWindowDays: The retention set for the + // continuous backup that was previously enabled prior to enabling BackupDR + // protection for this cluster. + ContinuousBackupPreviousRecoveryWindowDays int64 `json:"continuousBackupPreviousRecoveryWindowDays,omitempty"` + // ContinuousBackupPreviouslyEnabled: Whether continuous backup was previously + // enabled prior to enabling BackupDR protection for this cluster. + ContinuousBackupPreviouslyEnabled bool `json:"continuousBackupPreviouslyEnabled,omitempty"` + // ContinuousBackupPreviouslyEnabledTime: The time when continuous backup was + // previously enabled prior to enabling BackupDR protection for this cluster. + ContinuousBackupPreviouslyEnabledTime string `json:"continuousBackupPreviouslyEnabledTime,omitempty"` + // DataSource: The DataSource resource that represents the cluster in BackupDR. + DataSource string `json:"dataSource,omitempty"` + // DisabledTime: Time when the BackupDR protection for this cluster was + // disabled. This field will be empty if this BackupDR window is the + // `current_window`. + DisabledTime string `json:"disabledTime,omitempty"` + // EnabledTime: Time when the BackupDR protection for this cluster was enabled. + EnabledTime string `json:"enabledTime,omitempty"` + // LogRetentionPeriod: The retention period for logs generated by BackupDR for + // this cluster. + LogRetentionPeriod string `json:"logRetentionPeriod,omitempty"` + // ForceSendFields is a list of field names (e.g. + // "AutomatedBackupPreviouslyEnabled") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted from + // API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. + // "AutomatedBackupPreviouslyEnabled") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields for + // more details. + NullFields []string `json:"-"` +} + +func (s BackupDrEnabledWindow) MarshalJSON() ([]byte, error) { + type NoMethod BackupDrEnabledWindow + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// BackupDrInfo: Information about BackupDR protection for this cluster. +type BackupDrInfo struct { + // CurrentWindow: The current BackupDR configuration for this cluster. If + // BackupDR protection is not enabled for this cluster, this field will be + // empty. + CurrentWindow *BackupDrEnabledWindow `json:"currentWindow,omitempty"` + // PreviousWindows: Windows during which BackupDR was enabled for this cluster, + // along with associated configuration for that window. These are used to + // determine points-in-time for which restores can be performed. The windows + // are ordered with the most recent window last. Windows are mutally exclusive. + // Windows which closed more than 1 year ago will be removed from this list. + PreviousWindows []*BackupDrEnabledWindow `json:"previousWindows,omitempty"` + // ForceSendFields is a list of field names (e.g. "CurrentWindow") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "CurrentWindow") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s BackupDrInfo) MarshalJSON() ([]byte, error) { + type NoMethod BackupDrInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// BackupDrPitrSource: Message describing a BackupDrPitrSource. +type BackupDrPitrSource struct { + // DataSource: Required. The name of the backup resource with the format: * + // projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSou + // rces/{datasource_id} + DataSource string `json:"dataSource,omitempty"` + // PointInTime: Required. The point in time to restore to. + PointInTime string `json:"pointInTime,omitempty"` + // ForceSendFields is a list of field names (e.g. "DataSource") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DataSource") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s BackupDrPitrSource) MarshalJSON() ([]byte, error) { + type NoMethod BackupDrPitrSource + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // BackupSource: Message describing a BackupSource. type BackupSource struct { // BackupName: Required. The name of the backup resource with the format: * @@ -575,6 +730,11 @@ type Cluster struct { AutomatedBackupPolicy *AutomatedBackupPolicy `json:"automatedBackupPolicy,omitempty"` // BackupSource: Output only. Cluster created from backup. BackupSource *BackupSource `json:"backupSource,omitempty"` + // BackupdrBackupSource: Output only. Cluster created from a BackupDR backup. + BackupdrBackupSource *BackupDrBackupSource `json:"backupdrBackupSource,omitempty"` + // BackupdrInfo: Output only. Output only information about BackupDR protection + // for this cluster. + BackupdrInfo *BackupDrInfo `json:"backupdrInfo,omitempty"` // CloudsqlBackupRunSource: Output only. Cluster created from CloudSQL // snapshot. CloudsqlBackupRunSource *CloudSQLBackupRunSource `json:"cloudsqlBackupRunSource,omitempty"` @@ -966,6 +1126,42 @@ func (s ContinuousBackupSource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// CpuUtilization: CPU utilization policy for the autoscaler. +type CpuUtilization struct { + // UtilizationTarget: Target CPU utilization as a float between 0 and 1. + UtilizationTarget float64 `json:"utilizationTarget,omitempty"` + // ForceSendFields is a list of field names (e.g. "UtilizationTarget") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "UtilizationTarget") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s CpuUtilization) MarshalJSON() ([]byte, error) { + type NoMethod CpuUtilization + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *CpuUtilization) UnmarshalJSON(data []byte) error { + type NoMethod CpuUtilization + var s1 struct { + UtilizationTarget gensupport.JSONFloat64 `json:"utilizationTarget"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.UtilizationTarget = float64(s1.UtilizationTarget) + return nil +} + // CsvExportOptions: Options for exporting data in CSV format. type CsvExportOptions struct { // EscapeCharacter: Optional. Specifies the character that should appear before @@ -1886,6 +2082,11 @@ type ListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -2315,6 +2516,37 @@ func (s OperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// Policy: Policy for the autoscaler. +type Policy struct { + // CoolDownPeriodSec: The period of time in seconds after a new node is created + // before the autoscaler will incorporate its resource usage (e.g. CPU + // utilization) into the autoscaling recommendation algorithm. + CoolDownPeriodSec int64 `json:"coolDownPeriodSec,omitempty,string"` + // CpuUtilization: CPU utilization policy for the autoscaler. + CpuUtilization *CpuUtilization `json:"cpuUtilization,omitempty"` + // Enabled: If true, autoscaling is enabled for the instance. If not set, the + // default value is false. + Enabled bool `json:"enabled,omitempty"` + // MaxNodeCount: Maximum number of nodes for the autoscaler. + MaxNodeCount int64 `json:"maxNodeCount,omitempty,string"` + // ForceSendFields is a list of field names (e.g. "CoolDownPeriodSec") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "CoolDownPeriodSec") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s Policy) MarshalJSON() ([]byte, error) { + type NoMethod Policy + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // PrimaryConfig: Configuration for the primary cluster. It has the list of // clusters that are replicating from this cluster. This should be set if and // only if the cluster is of type PRIMARY. @@ -2618,17 +2850,20 @@ func (s QueryInsightsInstanceConfig) MarshalJSON() ([]byte, error) { // ReadPoolConfig: Configuration for a read pool instance. type ReadPoolConfig struct { + // AutoScalingConfig: Autoscaling configuration for the read pool instance. If + // not set, the read pool instance will not be autoscaled. + AutoScalingConfig *AutoScalingConfig `json:"autoScalingConfig,omitempty"` // NodeCount: Read capacity, i.e. number of nodes in a read pool instance. NodeCount int64 `json:"nodeCount,omitempty"` - // ForceSendFields is a list of field names (e.g. "NodeCount") to + // ForceSendFields is a list of field names (e.g. "AutoScalingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "NodeCount") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See + // NullFields is a list of field names (e.g. "AutoScalingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -2704,6 +2939,10 @@ func (s RestartInstanceRequest) MarshalJSON() ([]byte, error) { type RestoreClusterRequest struct { // BackupSource: Backup source. BackupSource *BackupSource `json:"backupSource,omitempty"` + // BackupdrBackupSource: BackupDR backup source. + BackupdrBackupSource *BackupDrBackupSource `json:"backupdrBackupSource,omitempty"` + // BackupdrPitrSource: BackupDR source used for point in time recovery. + BackupdrPitrSource *BackupDrPitrSource `json:"backupdrPitrSource,omitempty"` // Cluster: Required. The resource being created Cluster *Cluster `json:"cluster,omitempty"` // ClusterId: Required. ID of the requesting object. @@ -2772,6 +3011,43 @@ func (s RestoreFromCloudSQLRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// Schedule: A schedule for the autoscaler. +type Schedule struct { + // CronExpression: Cron expression for the triggering the schedule. See + // https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions + // for the syntax. + CronExpression string `json:"cronExpression,omitempty"` + // Description: Description of the schedule. + Description string `json:"description,omitempty"` + // Disabled: If true, the schedule is disabled. + Disabled bool `json:"disabled,omitempty"` + // DurationSec: Duration of the schedule. + DurationSec int64 `json:"durationSec,omitempty,string"` + // MinNodeCount: Minimum number of nodes in while the schedule is active. + MinNodeCount int64 `json:"minNodeCount,omitempty,string"` + // Name: Name of the schedule. + Name string `json:"name,omitempty"` + // TimeZone: The location-based IANA time zone for interpreting the schedule's + // start time. If no time zone is provided, UTC is used by default. + TimeZone string `json:"timeZone,omitempty"` + // ForceSendFields is a list of field names (e.g. "CronExpression") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "CronExpression") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s Schedule) MarshalJSON() ([]byte, error) { + type NoMethod Schedule + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // SecondaryConfig: Configuration information for the secondary cluster. This // should be set if and only if the cluster is of type SECONDARY. type SecondaryConfig struct { @@ -2927,44 +3203,10 @@ func (s StageInfo) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// StageSchedule: Timing information for the stage execution. -type StageSchedule struct { - // ActualEndTime: Actual end time of the stage. Set only if the stage has - // completed. - ActualEndTime string `json:"actualEndTime,omitempty"` - // ActualStartTime: Actual start time of the stage. Set only if the stage has - // started. - ActualStartTime string `json:"actualStartTime,omitempty"` - // EstimatedEndTime: When the stage is expected to end. Set only if the stage - // has not completed yet. - EstimatedEndTime string `json:"estimatedEndTime,omitempty"` - // EstimatedStartTime: When the stage is expected to start. Set only if the - // stage has not started yet. - EstimatedStartTime string `json:"estimatedStartTime,omitempty"` - // ForceSendFields is a list of field names (e.g. "ActualEndTime") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ActualEndTime") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s StageSchedule) MarshalJSON() ([]byte, error) { - type NoMethod StageSchedule - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // StageStatus: Status of an upgrade stage. type StageStatus struct { // ReadPoolInstancesUpgrade: Read pool instances upgrade metadata. ReadPoolInstancesUpgrade *ReadPoolInstancesUpgradeStageStatus `json:"readPoolInstancesUpgrade,omitempty"` - // Schedule: Output only. Timing information for the stage execution. - Schedule *StageSchedule `json:"schedule,omitempty"` // Stage: Upgrade stage. // // Possible values: @@ -3787,7 +4029,7 @@ func (s StorageDatabasecenterPartnerapiV1mainDatabaseResourceId) MarshalJSON() ( } // StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata: Common model -// for database resource instance metadata. Next ID: 27 +// for database resource instance metadata. Next ID: 29 type StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata struct { // AvailabilityConfiguration: Availability configuration for this instance AvailabilityConfiguration *StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration `json:"availabilityConfiguration,omitempty"` @@ -3864,6 +4106,8 @@ type StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata struct { Location string `json:"location,omitempty"` // MachineConfiguration: Machine configuration for this resource. MachineConfiguration *StorageDatabasecenterPartnerapiV1mainMachineConfiguration `json:"machineConfiguration,omitempty"` + // MaintenanceInfo: Optional. Maintenance info for the resource. + MaintenanceInfo *StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo `json:"maintenanceInfo,omitempty"` // PrimaryResourceId: Identifier for this resource's immediate parent/primary // resource if the current resource is a replica or derived form of another // Database resource. Else it would be NULL. REQUIRED if the immediate parent @@ -4511,6 +4755,118 @@ func (s StorageDatabasecenterPartnerapiV1mainOperationError) MarshalJSON() ([]by return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule: Deny +// maintenance period for the database resource. It specifies the time range +// during which the maintenance cannot start. This is configured by the +// customer. +type StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule struct { + // EndDate: Optional. Deny period end date. + EndDate *GoogleTypeDate `json:"endDate,omitempty"` + // StartDate: Optional. The start date of the deny maintenance period. + StartDate *GoogleTypeDate `json:"startDate,omitempty"` + // Time: Optional. Time in UTC when the deny period starts on start_date and + // ends on end_date. + Time *GoogleTypeTimeOfDay `json:"time,omitempty"` + // ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EndDate") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule) MarshalJSON() ([]byte, error) { + type NoMethod StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo: +// MaintenanceInfo to capture the maintenance details of database resource. +type StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo struct { + // DenyMaintenanceSchedules: Optional. List of Deny maintenance period for the + // database resource. + DenyMaintenanceSchedules []*StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule `json:"denyMaintenanceSchedules,omitempty"` + // MaintenanceSchedule: Optional. Maintenance window for the database resource. + MaintenanceSchedule *StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule `json:"maintenanceSchedule,omitempty"` + // MaintenanceVersion: Optional. Current Maintenance version of the database + // resource. Example: "MYSQL_8_0_41.R20250531.01_15" + MaintenanceVersion string `json:"maintenanceVersion,omitempty"` + // ForceSendFields is a list of field names (e.g. "DenyMaintenanceSchedules") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DenyMaintenanceSchedules") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo) MarshalJSON() ([]byte, error) { + type NoMethod StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule: +// Maintenance window for the database resource. It specifies preferred time +// and day of the week and phase in some cases, when the maintenance can start. +// This is configured by the customer. +type StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule struct { + // Day: Optional. Preferred day of the week for maintenance, e.g. MONDAY, + // TUESDAY, etc. + // + // Possible values: + // "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified. + // "MONDAY" - Monday + // "TUESDAY" - Tuesday + // "WEDNESDAY" - Wednesday + // "THURSDAY" - Thursday + // "FRIDAY" - Friday + // "SATURDAY" - Saturday + // "SUNDAY" - Sunday + Day string `json:"day,omitempty"` + // Phase: Optional. Phase of the maintenance window. This is to capture order + // of maintenance. For example, for Cloud SQL resources, this can be used to + // capture if the maintenance window is in Week1, Week2, Week5, etc. Non + // production resources are usually part of early phase. For more details, + // refer to Cloud SQL resources - + // https://cloud.google.com/sql/docs/mysql/maintenance + // + // Possible values: + // "WINDOW_PHASE_UNSPECIFIED" - Phase is unspecified. + // "WINDOW_PHASE_ANY" - Any phase. + // "WINDOW_PHASE_WEEK1" - Week 1. + // "WINDOW_PHASE_WEEK2" - Week 2. + // "WINDOW_PHASE_WEEK5" - Week 5. + Phase string `json:"phase,omitempty"` + // Time: Optional. Preferred time to start the maintenance operation on the + // specified day. + Time *GoogleTypeTimeOfDay `json:"time,omitempty"` + // ForceSendFields is a list of field names (e.g. "Day") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Day") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule) MarshalJSON() ([]byte, error) { + type NoMethod StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + type StorageDatabasecenterPartnerapiV1mainRetentionSettings struct { // DurationBasedRetention: Duration based retention period i.e. 172800 seconds // (2 days) @@ -10020,6 +10376,19 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/apigee/v1/apigee-api.json b/apigee/v1/apigee-api.json index e193e015001..6ad7ddc60e4 100644 --- a/apigee/v1/apigee-api.json +++ b/apigee/v1/apigee-api.json @@ -9309,6 +9309,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -11284,7 +11289,7 @@ } } }, - "revision": "20250908", + "revision": "20250929", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11901,12 +11906,14 @@ "enum": [ "QUOTA_COUNTER_SCOPE_UNSPECIFIED", "PROXY", - "OPERATION" + "OPERATION", + "PRODUCT" ], "enumDescriptions": [ "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association.", "When quota is not explicitly defined for each operation(REST/GraphQL), set at product level will be used as a global counter for quota evaluation by all the operations associated with a particular proxy.", - "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association. This behavior mimics the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED." + "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association. This behavior mimics the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED.", + "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a global counter for quota evaluation by all the operations." ], "type": "string" }, @@ -15194,6 +15201,11 @@ "description": "Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`", "type": "string" }, + "isVersionLocked": { + "description": "Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.", + "readOnly": true, + "type": "boolean" + }, "lastModifiedAt": { "description": "Output only. Time the instance was last modified in milliseconds since epoch.", "format": "int64", @@ -15204,6 +15216,10 @@ "description": "Required. Compute Engine location where the instance resides.", "type": "string" }, + "maintenanceUpdatePolicy": { + "$ref": "GoogleCloudApigeeV1MaintenanceUpdatePolicy", + "description": "Optional. Apigee customers can set the preferred window to perform maintenance on the instance (day of the week and time of day)." + }, "name": { "description": "Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\\d]$`.", "type": "string" @@ -15243,6 +15259,11 @@ "readOnly": true, "type": "string" }, + "scheduledMaintenance": { + "$ref": "GoogleCloudApigeeV1ScheduledMaintenance", + "description": "Output only. Time and date of the scheduled maintenance for this instance. This field is only populated for instances that have opted into Maintenance Window and if there is an upcoming maintenance. Cleared once the maintenance is complete.", + "readOnly": true + }, "serviceAttachment": { "description": "Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.", "readOnly": true, @@ -16175,6 +16196,69 @@ }, "type": "object" }, + "GoogleCloudApigeeV1MaintenanceUpdatePolicy": { + "description": "MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day).", + "id": "GoogleCloudApigeeV1MaintenanceUpdatePolicy", + "properties": { + "maintenanceChannel": { + "description": "Optional. Maintenance channel to specify relative scheduling for maintenance.", + "enum": [ + "MAINTENANCE_CHANNEL_UNSPECIFIED", + "WEEK1", + "WEEK2" + ], + "enumDescriptions": [ + "Unspecified maintenance channel.", + "Receive 1 weeks notice before maintenance occurs", + "Receive 2 weeks notice before maintenance occurs" + ], + "type": "string" + }, + "maintenanceWindows": { + "description": "Optional. Preferred windows to perform maintenance. Currently limited to 1.", + "items": { + "$ref": "GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow": { + "description": "MaintenanceWindow specifies the preferred day of the week and time of day to perform maintenance.", + "id": "GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow", + "properties": { + "day": { + "description": "Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "startTime": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Required. The start time (UTC) of the maintenance window." + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Metadata": { "description": "Encapsulates additional information about query execution.", "id": "GoogleCloudApigeeV1Metadata", @@ -18007,6 +18091,19 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ScheduledMaintenance": { + "description": "Scheduled maintenance information for an instance.", + "id": "GoogleCloudApigeeV1ScheduledMaintenance", + "properties": { + "startTime": { + "description": "Output only. The start time (UTC) of the scheduled maintenance.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Schema": { "description": "Response for Schema call", "id": "GoogleCloudApigeeV1Schema", @@ -20132,6 +20229,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -20297,6 +20401,33 @@ } }, "type": "object" + }, + "GoogleTypeTimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "GoogleTypeTimeOfDay", + "properties": { + "hours": { + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/apigee/v1/apigee-gen.go b/apigee/v1/apigee-gen.go index 48dcc88dcaa..8a72039c7d2 100644 --- a/apigee/v1/apigee-gen.go +++ b/apigee/v1/apigee-gen.go @@ -2158,6 +2158,9 @@ type GoogleCloudApigeeV1ApiProduct struct { // local counter for quota evaluation by all the operations, independent of // proxy association. This behavior mimics the same as // QUOTA_COUNTER_SCOPE_UNSPECIFIED. + // "PRODUCT" - When quota is not explicitly defined for each + // operation(REST/GraphQL), the limits set at product level will be used as a + // global counter for quota evaluation by all the operations. QuotaCounterScope string `json:"quotaCounterScope,omitempty"` // QuotaInterval: Time interval over which the number of request messages is // calculated. @@ -5769,11 +5772,19 @@ type GoogleCloudApigeeV1Instance struct { // firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or // `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` IpRange string `json:"ipRange,omitempty"` + // IsVersionLocked: Output only. Indicates whether the instance is version + // locked. If true, the instance will not be updated by automated runtime + // rollouts. This is only supported for Apigee X instances. + IsVersionLocked bool `json:"isVersionLocked,omitempty"` // LastModifiedAt: Output only. Time the instance was last modified in // milliseconds since epoch. LastModifiedAt int64 `json:"lastModifiedAt,omitempty,string"` // Location: Required. Compute Engine location where the instance resides. Location string `json:"location,omitempty"` + // MaintenanceUpdatePolicy: Optional. Apigee customers can set the preferred + // window to perform maintenance on the instance (day of the week and time of + // day). + MaintenanceUpdatePolicy *GoogleCloudApigeeV1MaintenanceUpdatePolicy `json:"maintenanceUpdatePolicy,omitempty"` // Name: Required. Resource ID of the instance. Values must match the regular // expression `^a-z{0,30}[a-z\d]$`. Name string `json:"name,omitempty"` @@ -5798,6 +5809,11 @@ type GoogleCloudApigeeV1Instance struct { // instance. The runtime system is the set of components that serve the API // Proxy traffic in your Environments. RuntimeVersion string `json:"runtimeVersion,omitempty"` + // ScheduledMaintenance: Output only. Time and date of the scheduled + // maintenance for this instance. This field is only populated for instances + // that have opted into Maintenance Window and if there is an upcoming + // maintenance. Cleared once the maintenance is complete. + ScheduledMaintenance *GoogleCloudApigeeV1ScheduledMaintenance `json:"scheduledMaintenance,omitempty"` // ServiceAttachment: Output only. Resource name of the service attachment // created for the instance in the format: // `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately @@ -7289,6 +7305,76 @@ func (s GoogleCloudApigeeV1ListTraceConfigOverridesResponse) MarshalJSON() ([]by return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudApigeeV1MaintenanceUpdatePolicy: MaintenanceUpdatePolicy +// specifies the preferred window to perform maintenance on the instance (day +// of the week and time of day). +type GoogleCloudApigeeV1MaintenanceUpdatePolicy struct { + // MaintenanceChannel: Optional. Maintenance channel to specify relative + // scheduling for maintenance. + // + // Possible values: + // "MAINTENANCE_CHANNEL_UNSPECIFIED" - Unspecified maintenance channel. + // "WEEK1" - Receive 1 weeks notice before maintenance occurs + // "WEEK2" - Receive 2 weeks notice before maintenance occurs + MaintenanceChannel string `json:"maintenanceChannel,omitempty"` + // MaintenanceWindows: Optional. Preferred windows to perform maintenance. + // Currently limited to 1. + MaintenanceWindows []*GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow `json:"maintenanceWindows,omitempty"` + // ForceSendFields is a list of field names (e.g. "MaintenanceChannel") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "MaintenanceChannel") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudApigeeV1MaintenanceUpdatePolicy) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudApigeeV1MaintenanceUpdatePolicy + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow: +// MaintenanceWindow specifies the preferred day of the week and time of day to +// perform maintenance. +type GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow struct { + // Day: Required. Preferred day of the week for maintenance, e.g. MONDAY, + // TUESDAY, etc. + // + // Possible values: + // "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified. + // "MONDAY" - Monday + // "TUESDAY" - Tuesday + // "WEDNESDAY" - Wednesday + // "THURSDAY" - Thursday + // "FRIDAY" - Friday + // "SATURDAY" - Saturday + // "SUNDAY" - Sunday + Day string `json:"day,omitempty"` + // StartTime: Required. The start time (UTC) of the maintenance window. + StartTime *GoogleTypeTimeOfDay `json:"startTime,omitempty"` + // ForceSendFields is a list of field names (e.g. "Day") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Day") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudApigeeV1Metadata: Encapsulates additional information about query // execution. type GoogleCloudApigeeV1Metadata struct { @@ -9517,6 +9603,29 @@ func (s *GoogleCloudApigeeV1RuntimeTraceSamplingConfig) UnmarshalJSON(data []byt return nil } +// GoogleCloudApigeeV1ScheduledMaintenance: Scheduled maintenance information +// for an instance. +type GoogleCloudApigeeV1ScheduledMaintenance struct { + // StartTime: Output only. The start time (UTC) of the scheduled maintenance. + StartTime string `json:"startTime,omitempty"` + // ForceSendFields is a list of field names (e.g. "StartTime") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "StartTime") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudApigeeV1ScheduledMaintenance) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudApigeeV1ScheduledMaintenance + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudApigeeV1Schema: Response for Schema call type GoogleCloudApigeeV1Schema struct { // Dimensions: List of schema fields grouped as dimensions. @@ -12190,6 +12299,11 @@ type GoogleLongrunningListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -12470,6 +12584,43 @@ func (s GoogleTypeMoney) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleTypeTimeOfDay: Represents a time of day. The date and time zone are +// either not significant or are specified elsewhere. An API may choose to +// allow leap seconds. Related types are google.type.Date and +// `google.protobuf.Timestamp`. +type GoogleTypeTimeOfDay struct { + // Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0 + // and typically must be less than or equal to 23. An API may choose to allow + // the value "24:00:00" for scenarios like business closing time. + Hours int64 `json:"hours,omitempty"` + // Minutes: Minutes of an hour. Must be greater than or equal to 0 and less + // than or equal to 59. + Minutes int64 `json:"minutes,omitempty"` + // Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal + // to 0 and less than or equal to 999,999,999. + Nanos int64 `json:"nanos,omitempty"` + // Seconds: Seconds of a minute. Must be greater than or equal to 0 and + // typically must be less than or equal to 59. An API may allow the value 60 if + // it allows leap-seconds. + Seconds int64 `json:"seconds,omitempty"` + // ForceSendFields is a list of field names (e.g. "Hours") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Hours") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleTypeTimeOfDay) MarshalJSON() ([]byte, error) { + type NoMethod GoogleTypeTimeOfDay + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + type HybridIssuersListCall struct { s *Service name string @@ -46734,6 +46885,19 @@ func (c *OrganizationsOperationsListCall) PageToken(pageToken string) *Organizat return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *OrganizationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *OrganizationsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/apim/v1alpha/apim-api.json b/apim/v1alpha/apim-api.json index 8fd2283266f..9d4cd7afa19 100644 --- a/apim/v1alpha/apim-api.json +++ b/apim/v1alpha/apim-api.json @@ -829,6 +829,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}/operations", @@ -846,7 +851,7 @@ } } }, - "revision": "20250910", + "revision": "20250924", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { @@ -1419,6 +1424,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/apim/v1alpha/apim-gen.go b/apim/v1alpha/apim-gen.go index 3daa44283c3..70daa62204b 100644 --- a/apim/v1alpha/apim-gen.go +++ b/apim/v1alpha/apim-gen.go @@ -881,6 +881,11 @@ type ListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -3891,6 +3896,19 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/bigquery/v2/bigquery-api.json b/bigquery/v2/bigquery-api.json index 89425b8fc42..bea1bb2cf8c 100644 --- a/bigquery/v2/bigquery-api.json +++ b/bigquery/v2/bigquery-api.json @@ -2375,7 +2375,7 @@ } } }, - "revision": "20250919", + "revision": "20250928", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -4639,6 +4639,14 @@ "timestampFormat": { "description": "Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.", "type": "string" + }, + "timestampTargetPrecision": { + "description": "Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" } }, "type": "object" @@ -5512,7 +5520,7 @@ "description": "[Pick one] Configures a load job." }, "maxSlots": { - "description": "Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate.", + "description": "Optional. A target limit on the rate of slot consumption by this job. If set to a value \u003e 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.", "format": "int32", "type": "integer" }, @@ -5822,6 +5830,14 @@ "description": "Optional. Date format used for parsing TIMESTAMP values.", "type": "string" }, + "timestampTargetPrecision": { + "description": "Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV. For the CSV Format, Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, "useAvroLogicalTypes": { "description": "Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).", "type": "boolean" @@ -6244,6 +6260,14 @@ "readOnly": true, "type": "array" }, + "reservationGroupPath": { + "description": "Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "reservationUsage": { "deprecated": true, "description": "Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.", @@ -7877,7 +7901,7 @@ "type": "integer" }, "maxSlots": { - "description": "Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to allow for this job. If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. This limit is best effort.", + "description": "Optional. A target limit on the rate of slot consumption by this query. If set to a value \u003e 0, BigQuery will attempt to limit the rate of slot consumption by this query to keep it below the configured limit, even if the query is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.", "format": "int32", "type": "integer" }, diff --git a/bigquery/v2/bigquery-gen.go b/bigquery/v2/bigquery-gen.go index b6a1fc41a51..bbe6a8897be 100644 --- a/bigquery/v2/bigquery-gen.go +++ b/bigquery/v2/bigquery-gen.go @@ -3364,6 +3364,17 @@ type ExternalDataConfiguration struct { // TimestampFormat: Optional. Format used to parse TIMESTAMP values. Supports // C-style and SQL-style values. TimestampFormat string `json:"timestampFormat,omitempty"` + // TimestampTargetPrecision: Precisions (maximum number of total digits in base + // 10) for seconds of TIMESTAMP types that are allowed to the destination table + // for autodetection mode. Available for the formats: CSV. For the CSV Format, + // Possible values include: Not Specified, [], or [6]: timestamp(6) for all + // auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected + // TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) + // for all auto detected TIMESTAMP columns that have more than 6 digits of + // subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The + // order of the elements in this array is ignored. Inputs that have higher + // precision than the highest target precision in this array will be truncated. + TimestampTargetPrecision []int64 `json:"timestampTargetPrecision,omitempty"` // ForceSendFields is a list of field names (e.g. "Autodetect") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See @@ -4507,10 +4518,12 @@ type JobConfiguration struct { Labels map[string]string `json:"labels,omitempty"` // Load: [Pick one] Configures a load job. Load *JobConfigurationLoad `json:"load,omitempty"` - // MaxSlots: Optional. INTERNAL: DO NOT USE. The maximum rate of slot - // consumption to allow for this job. If set, the number of slots used to - // execute the job will be throttled to try and keep its slot consumption below - // the requested rate. + // MaxSlots: Optional. A target limit on the rate of slot consumption by this + // job. If set to a value > 0, BigQuery will attempt to limit the rate of slot + // consumption by this job to keep it below the configured limit, even if the + // job is eligible for more slots based on fair scheduling. The unused slots + // will be available for other jobs and queries to use. Note: This feature is + // not yet generally available. MaxSlots int64 `json:"maxSlots,omitempty"` // Query: [Pick one] Configures a query job. Query *JobConfigurationQuery `json:"query,omitempty"` @@ -4892,6 +4905,17 @@ type JobConfigurationLoad struct { TimeZone string `json:"timeZone,omitempty"` // TimestampFormat: Optional. Date format used for parsing TIMESTAMP values. TimestampFormat string `json:"timestampFormat,omitempty"` + // TimestampTargetPrecision: Precisions (maximum number of total digits in base + // 10) for seconds of TIMESTAMP types that are allowed to the destination table + // for autodetection mode. Available for the formats: CSV. For the CSV Format, + // Possible values include: Not Specified, [], or [6]: timestamp(6) for all + // auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected + // TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) + // for all auto detected TIMESTAMP columns that have more than 6 digits of + // subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The + // order of the elements in this array is ignored. Inputs that have higher + // precision than the highest target precision in this array will be truncated. + TimestampTargetPrecision []int64 `json:"timestampTargetPrecision,omitempty"` // UseAvroLogicalTypes: Optional. If sourceFormat is set to "AVRO", indicates // whether to interpret logical types as the corresponding BigQuery data type // (for example, TIMESTAMP), instead of using the raw type (for example, @@ -5360,6 +5384,13 @@ type JobStatistics struct { Query *JobStatistics2 `json:"query,omitempty"` // QuotaDeferments: Output only. Quotas which delayed this job's start time. QuotaDeferments []string `json:"quotaDeferments,omitempty"` + // ReservationGroupPath: Output only. The reservation group path of the + // reservation assigned to this job. This field has a limit of 10 nested + // reservation groups. This is to maintain consistency between reservatins info + // schema and jobs info schema. The first reservation group is the root + // reservation group and the last is the leaf or lowest level reservation + // group. + ReservationGroupPath []string `json:"reservationGroupPath,omitempty"` // ReservationUsage: Output only. Job resource usage breakdown by reservation. // This field reported misleading information and will no longer be populated. ReservationUsage []*JobStatisticsReservationUsage `json:"reservationUsage,omitempty"` @@ -7287,10 +7318,12 @@ type QueryRequest struct { // large. In addition to this limit, responses are also limited to 10 MB. By // default, there is no maximum row count, and only the byte limit applies. MaxResults int64 `json:"maxResults,omitempty"` - // MaxSlots: Optional. INTERNAL: DO NOT USE. The maximum rate of slot - // consumption to allow for this job. If set, the number of slots used to - // execute the job will be throttled to try and keep its slot consumption below - // the requested rate. This limit is best effort. + // MaxSlots: Optional. A target limit on the rate of slot consumption by this + // query. If set to a value > 0, BigQuery will attempt to limit the rate of + // slot consumption by this query to keep it below the configured limit, even + // if the query is eligible for more slots based on fair scheduling. The unused + // slots will be available for other jobs and queries to use. Note: This + // feature is not yet generally available. MaxSlots int64 `json:"maxSlots,omitempty"` // MaximumBytesBilled: Optional. Limits the bytes billed for this query. // Queries with bytes billed above this limit will fail (without incurring a diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json index 99ca7670ba7..ea65c8d3df2 100644 --- a/classroom/v1/classroom-api.json +++ b/classroom/v1/classroom-api.json @@ -4107,7 +4107,7 @@ } } }, - "revision": "20250827", + "revision": "20250929", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -4464,7 +4464,7 @@ }, "gradebookSettings": { "$ref": "GradebookSettings", - "description": "The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only" + "description": "The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only." }, "guardiansEnabled": { "description": "Whether or not guardian notifications are enabled for this course. Read-only.", diff --git a/classroom/v1/classroom-gen.go b/classroom/v1/classroom-gen.go index 81f083e4106..bf3c1730fa3 100644 --- a/classroom/v1/classroom-gen.go +++ b/classroom/v1/classroom-gen.go @@ -964,7 +964,7 @@ type Course struct { EnrollmentCode string `json:"enrollmentCode,omitempty"` // GradebookSettings: The gradebook settings that specify how a student's // overall grade for the course will be calculated and who it will be displayed - // to. Read-only + // to. Read-only. GradebookSettings *GradebookSettings `json:"gradebookSettings,omitempty"` // GuardiansEnabled: Whether or not guardian notifications are enabled for this // course. Read-only. diff --git a/cloudchannel/v1/cloudchannel-api.json b/cloudchannel/v1/cloudchannel-api.json index 70c5d4ce3ad..6fadb145251 100644 --- a/cloudchannel/v1/cloudchannel-api.json +++ b/cloudchannel/v1/cloudchannel-api.json @@ -2183,6 +2183,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -2289,7 +2294,7 @@ } } }, - "revision": "20250809", + "revision": "20250929", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -5851,6 +5856,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/cloudchannel/v1/cloudchannel-gen.go b/cloudchannel/v1/cloudchannel-gen.go index 97a2ee3282f..dbd00506290 100644 --- a/cloudchannel/v1/cloudchannel-gen.go +++ b/cloudchannel/v1/cloudchannel-gen.go @@ -4913,6 +4913,11 @@ type GoogleLongrunningListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -13494,6 +13499,19 @@ func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall { return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *OperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *OperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json index b33a6305608..d1fdf64df47 100644 --- a/cloudkms/v1/cloudkms-api.json +++ b/cloudkms/v1/cloudkms-api.json @@ -229,7 +229,7 @@ ] }, "getKajPolicyConfig": { - "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", + "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/folders/{foldersId}/kajPolicyConfig", "httpMethod": "GET", "id": "cloudkms.folders.getKajPolicyConfig", @@ -290,7 +290,7 @@ ] }, "updateKajPolicyConfig": { - "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", + "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/folders/{foldersId}/kajPolicyConfig", "httpMethod": "PATCH", "id": "cloudkms.folders.updateKajPolicyConfig", @@ -329,7 +329,7 @@ "organizations": { "methods": { "getKajPolicyConfig": { - "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", + "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/organizations/{organizationsId}/kajPolicyConfig", "httpMethod": "GET", "id": "cloudkms.organizations.getKajPolicyConfig", @@ -355,7 +355,7 @@ ] }, "updateKajPolicyConfig": { - "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", + "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/organizations/{organizationsId}/kajPolicyConfig", "httpMethod": "PATCH", "id": "cloudkms.organizations.updateKajPolicyConfig", @@ -420,7 +420,7 @@ ] }, "getKajPolicyConfig": { - "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", + "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", "httpMethod": "GET", "id": "cloudkms.projects.getKajPolicyConfig", @@ -559,7 +559,7 @@ ] }, "updateKajPolicyConfig": { - "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.", + "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.", "flatPath": "v1/projects/{projectsId}/kajPolicyConfig", "httpMethod": "PATCH", "id": "cloudkms.projects.updateKajPolicyConfig", @@ -2496,7 +2496,7 @@ } } }, - "revision": "20250911", + "revision": "20250926", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/cloudkms/v1/cloudkms-gen.go b/cloudkms/v1/cloudkms-gen.go index a6fdacdb242..7c55a30beb0 100644 --- a/cloudkms/v1/cloudkms-gen.go +++ b/cloudkms/v1/cloudkms-gen.go @@ -3888,7 +3888,7 @@ type FoldersGetKajPolicyConfigCall struct { } // GetKajPolicyConfig: Gets the KeyAccessJustificationsPolicyConfig for a given -// organization/folder/projects. +// organization, folder, or project. // // - name: The name of the KeyAccessJustificationsPolicyConfig to get. func (r *FoldersService) GetKajPolicyConfig(name string) *FoldersGetKajPolicyConfigCall { @@ -4115,7 +4115,7 @@ type FoldersUpdateKajPolicyConfigCall struct { } // UpdateKajPolicyConfig: Updates the KeyAccessJustificationsPolicyConfig for a -// given organization/folder/projects. +// given organization, folder, or project. // // - name: Identifier. The resource name for this // KeyAccessJustificationsPolicyConfig in the format of @@ -4229,7 +4229,7 @@ type OrganizationsGetKajPolicyConfigCall struct { } // GetKajPolicyConfig: Gets the KeyAccessJustificationsPolicyConfig for a given -// organization/folder/projects. +// organization, folder, or project. // // - name: The name of the KeyAccessJustificationsPolicyConfig to get. func (r *OrganizationsService) GetKajPolicyConfig(name string) *OrganizationsGetKajPolicyConfigCall { @@ -4340,7 +4340,7 @@ type OrganizationsUpdateKajPolicyConfigCall struct { } // UpdateKajPolicyConfig: Updates the KeyAccessJustificationsPolicyConfig for a -// given organization/folder/projects. +// given organization, folder, or project. // // - name: Identifier. The resource name for this // KeyAccessJustificationsPolicyConfig in the format of @@ -4565,7 +4565,7 @@ type ProjectsGetKajPolicyConfigCall struct { } // GetKajPolicyConfig: Gets the KeyAccessJustificationsPolicyConfig for a given -// organization/folder/projects. +// organization, folder, or project. // // - name: The name of the KeyAccessJustificationsPolicyConfig to get. func (r *ProjectsService) GetKajPolicyConfig(name string) *ProjectsGetKajPolicyConfigCall { @@ -5131,7 +5131,7 @@ type ProjectsUpdateKajPolicyConfigCall struct { } // UpdateKajPolicyConfig: Updates the KeyAccessJustificationsPolicyConfig for a -// given organization/folder/projects. +// given organization, folder, or project. // // - name: Identifier. The resource name for this // KeyAccessJustificationsPolicyConfig in the format of diff --git a/cloudshell/v1/cloudshell-api.json b/cloudshell/v1/cloudshell-api.json index 77d9fb9d4be..edecda4933d 100644 --- a/cloudshell/v1/cloudshell-api.json +++ b/cloudshell/v1/cloudshell-api.json @@ -216,6 +216,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -374,7 +379,7 @@ } } }, - "revision": "20241118", + "revision": "20250930", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { @@ -543,6 +548,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/cloudshell/v1/cloudshell-gen.go b/cloudshell/v1/cloudshell-gen.go index 7b8fbd366a9..050882d0eca 100644 --- a/cloudshell/v1/cloudshell-gen.go +++ b/cloudshell/v1/cloudshell-gen.go @@ -375,6 +375,11 @@ type ListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -959,6 +964,19 @@ func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall { return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *OperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *OperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json index 22881ce4ae1..41298b36dde 100644 --- a/dialogflow/v2beta1/dialogflow-api.json +++ b/dialogflow/v2beta1/dialogflow-api.json @@ -8024,6 +8024,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2beta1/{+name}/operations", @@ -8512,6 +8517,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2beta1/{+name}/operations", @@ -8726,7 +8736,7 @@ } } }, - "revision": "20250919", + "revision": "20250930", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -13605,6 +13615,207 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2AgentCoachingInstruction": { + "description": "Agent Coaching instructions that customer can configure.", + "id": "GoogleCloudDialogflowV2AgentCoachingInstruction", + "properties": { + "agentAction": { + "description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", + "type": "string" + }, + "condition": { + "description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", + "type": "string" + }, + "displayDetails": { + "description": "Optional. The detailed description of this instruction.", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name for the instruction.", + "type": "string" + }, + "duplicateCheckResult": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", + "description": "Output only. Duplication check for the AgentCoachingInstruction.", + "readOnly": true + }, + "systemAction": { + "description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult": { + "description": "Duplication check for the suggestion.", + "id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult", + "properties": { + "duplicateSuggestions": { + "description": "Output only. The duplicate suggestions.", + "items": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { + "description": "The duplicate suggestion details.", + "id": "GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", + "properties": { + "answerRecord": { + "description": "Output only. The answer record id of the past duplicate suggestion.", + "readOnly": true, + "type": "string" + }, + "similarityScore": { + "description": "Output only. The similarity score of between the past and current suggestion.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "suggestionIndex": { + "description": "Output only. The index of the duplicate suggestion in the past suggestion list.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingSuggestion": { + "description": "Suggestion for coaching agents.", + "id": "GoogleCloudDialogflowV2AgentCoachingSuggestion", + "properties": { + "agentActionSuggestions": { + "description": "Optional. Suggested actions for the agent to take.", + "items": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion" + }, + "type": "array" + }, + "applicableInstructions": { + "description": "Optional. Instructions applicable based on the current context.", + "items": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingInstruction" + }, + "type": "array" + }, + "sampleResponses": { + "description": "Optional. Sample response for the Agent.", + "items": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion": { + "description": "Actions suggested for the agent. This is based on applicable instructions.", + "id": "GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion", + "properties": { + "agentAction": { + "description": "Optional. The suggested action for the agent.", + "type": "string" + }, + "duplicateCheckResult": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", + "description": "Output only. Duplicate check result for the agent action suggestion.", + "readOnly": true + }, + "sources": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", + "description": "Output only. Sources for the agent action suggestion.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult": { + "description": "Duplication check for the suggestion.", + "id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", + "properties": { + "duplicateSuggestions": { + "description": "Output only. The duplicate suggestions.", + "items": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { + "description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", + "id": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", + "properties": { + "answerRecord": { + "description": "Output only. The answer record id of the past duplicate suggestion.", + "readOnly": true, + "type": "string" + }, + "similarityScore": { + "description": "Output only. The similarity score of between the past and current suggestion.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "sources": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", + "description": "Output only. Sources for the suggestion.", + "readOnly": true + }, + "suggestionIndex": { + "description": "Output only. The index of the duplicate suggestion in the past suggestion list.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse": { + "description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", + "id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse", + "properties": { + "duplicateCheckResult": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult", + "description": "Output only. Duplicate check result for the sample response.", + "readOnly": true + }, + "responseText": { + "description": "Optional. Sample response for Agent in text.", + "type": "string" + }, + "sources": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", + "description": "Output only. Sources for the Sample Response.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AgentCoachingSuggestionSources": { + "description": "Sources for the suggestion.", + "id": "GoogleCloudDialogflowV2AgentCoachingSuggestionSources", + "properties": { + "instructionIndexes": { + "description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2AnnotatedMessagePart": { "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", @@ -14288,6 +14499,10 @@ "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", "properties": { + "agentCoachingSuggestion": { + "$ref": "GoogleCloudDialogflowV2AgentCoachingSuggestion", + "description": "Optional. Suggestion to coach the agent." + }, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -16068,6 +16283,10 @@ "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, + "answerRecord": { + "description": "Optional. The answer record associated with this tool call.", + "type": "string" + }, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -16082,9 +16301,32 @@ "description": "Optional. The action's input parameters.", "type": "object" }, + "state": { + "description": "Output only. State of the tool call.", + "enum": [ + "STATE_UNSPECIFIED", + "TRIGGERED", + "NEEDS_CONFIRMATION" + ], + "enumDescriptions": [ + "Default value.", + "The tool call has been triggered.", + "The tool call requires confirmation from a human." + ], + "readOnly": true, + "type": "string" + }, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" + }, + "toolDisplayDetails": { + "description": "Optional. A human readable description of the tool.", + "type": "string" + }, + "toolDisplayName": { + "description": "Optional. A human readable short name of the tool, to be shown on the UI.", + "type": "string" } }, "type": "object" @@ -16097,6 +16339,10 @@ "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, + "answerRecord": { + "description": "Optional. The answer record associated with this tool call result.", + "type": "string" + }, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -16478,6 +16724,233 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1AgentCoachingContext": { + "description": "Agent Coaching context that customer can configure.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingContext", + "properties": { + "instructions": { + "description": "Optional. Customized instructions for agent coaching.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" + }, + "type": "array" + }, + "outputLanguageCode": { + "description": "Optional. Output language code.", + "type": "string" + }, + "overarchingGuidance": { + "description": "Optional. The overarching guidance for the agent coaching. This should be set only for v1.5 and later versions.", + "type": "string" + }, + "version": { + "description": "Optional. Version of the feature. If not set, default to latest version. Current candidates are [\"2.5\"].", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingInstruction": { + "description": "Agent Coaching instructions that customer can configure.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction", + "properties": { + "agentAction": { + "description": "Optional. The action that human agent should take. For example, \"apologize for the slow shipping\". If the users only want to use agent coaching for intent detection, agent_action can be empty", + "type": "string" + }, + "condition": { + "description": "Optional. The condition of the instruction. For example, \"the customer wants to cancel an order\". If the users want the instruction to be triggered unconditionally, the condition can be empty.", + "type": "string" + }, + "displayDetails": { + "description": "Optional. The detailed description of this instruction.", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name for the instruction.", + "type": "string" + }, + "duplicateCheckResult": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", + "description": "Output only. Duplication check for the AgentCoachingInstruction.", + "readOnly": true + }, + "systemAction": { + "description": "Optional. The action that system should take. For example, \"call GetOrderTime with order_number={order number provided by the customer}\". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult": { + "description": "Duplication check for the suggestion.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult", + "properties": { + "duplicateSuggestions": { + "description": "Output only. The duplicate suggestions.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion": { + "description": "The duplicate suggestion details.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion", + "properties": { + "answerRecord": { + "description": "Output only. The answer record id of the past duplicate suggestion.", + "readOnly": true, + "type": "string" + }, + "similarityScore": { + "description": "Output only. The similarity score of between the past and current suggestion.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "suggestionIndex": { + "description": "Output only. The index of the duplicate suggestion in the past suggestion list.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion": { + "description": "Suggestion for coaching agents.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", + "properties": { + "agentActionSuggestions": { + "description": "Optional. Suggested actions for the agent to take.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion" + }, + "type": "array" + }, + "applicableInstructions": { + "description": "Optional. Instructions applicable based on the current context.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingInstruction" + }, + "type": "array" + }, + "sampleResponses": { + "description": "Optional. Sample response for the Agent.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion": { + "description": "Actions suggested for the agent. This is based on applicable instructions.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion", + "properties": { + "agentAction": { + "description": "Optional. The suggested action for the agent.", + "type": "string" + }, + "duplicateCheckResult": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", + "description": "Output only. Duplicate check result for the agent action suggestion.", + "readOnly": true + }, + "sources": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", + "description": "Output only. Sources for the agent action suggestion.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult": { + "description": "Duplication check for the suggestion.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", + "properties": { + "duplicateSuggestions": { + "description": "Output only. The duplicate suggestions.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion": { + "description": "The duplicate suggestion details. Keeping answer_record and sources together as they are identifiers for duplicate suggestions.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion", + "properties": { + "answerRecord": { + "description": "Output only. The answer record id of the past duplicate suggestion.", + "readOnly": true, + "type": "string" + }, + "similarityScore": { + "description": "Output only. The similarity score of between the past and current suggestion.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "sources": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", + "description": "Output only. Sources for the suggestion.", + "readOnly": true + }, + "suggestionIndex": { + "description": "Output only. The index of the duplicate suggestion in the past suggestion list.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse": { + "description": "Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse", + "properties": { + "duplicateCheckResult": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult", + "description": "Output only. Duplicate check result for the sample response.", + "readOnly": true + }, + "responseText": { + "description": "Optional. Sample response for Agent in text.", + "type": "string" + }, + "sources": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", + "description": "Output only. Sources for the Sample Response.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources": { + "description": "Sources for the suggestion.", + "id": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources", + "properties": { + "instructionIndexes": { + "description": "Output only. Source instruction indexes for the suggestion. This is the index of the applicable_instructions field.", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1AnalyzeContentRequest": { "description": "The request message for Participants.AnalyzeContent.", "id": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest", @@ -17418,6 +17891,10 @@ "description": "Contents ingested.", "id": "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent", "properties": { + "answerRecord": { + "description": "If the context content was generated from a tool call, specify the answer record associated with the tool call. Format: `projects//locations//answerRecords/`.", + "type": "string" + }, "content": { "description": "Required. The information ingested in a single request.", "type": "string" @@ -18582,6 +19059,10 @@ "description": "LLM generator.", "id": "GoogleCloudDialogflowV2beta1Generator", "properties": { + "agentCoachingContext": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingContext", + "description": "Input of Agent Coaching feature." + }, "createTime": { "description": "Output only. Creation time of this generator.", "format": "google-datetime", @@ -18609,6 +19090,10 @@ "description": "Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.", "type": "string" }, + "suggestionDedupingConfig": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestionDedupingConfig", + "description": "Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature." + }, "summarizationContext": { "$ref": "GoogleCloudDialogflowV2beta1SummarizationContext", "description": "Input of Summarization feature." @@ -18685,6 +19170,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status", + "readOnly": true, + "type": "boolean" + }, "summarizationMetrics": { "$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics", "description": "Output only. Only available when the summarization generator is provided.", @@ -18844,6 +19339,10 @@ "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "properties": { + "agentCoachingSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingSuggestion", + "description": "Optional. Suggestion to coach the agent." + }, "freeFormSuggestion": { "$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion", "description": "Optional. Free form suggestion." @@ -18950,6 +19449,10 @@ "description": "Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST", "type": "boolean" }, + "enableAsyncToolCall": { + "description": "Optional. If true, enable asynchronous execution of tools.", + "type": "boolean" + }, "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "items": { @@ -18967,6 +19470,14 @@ "groupSuggestionResponses": { "description": "If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse.", "type": "boolean" + }, + "skipEmptyEventBasedSuggestion": { + "description": "Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.", + "type": "boolean" + }, + "useUnredactedConversationData": { + "description": "Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)", + "type": "boolean" } }, "type": "object" @@ -19003,10 +19514,18 @@ "description": "Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST", "type": "boolean" }, + "enableResponseDebugInfo": { + "description": "Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST", + "type": "boolean" + }, "queryConfig": { "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Configs of query." }, + "raiSettings": { + "$ref": "GoogleCloudDialogflowV2beta1RaiSettings", + "description": "Optional. Settings for Responsible AI checks. Supported features: KNOWLEDGE_ASSIST" + }, "suggestionFeature": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionFeature", "description": "The suggestion feature." @@ -21826,6 +22345,63 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1RaiSettings": { + "description": "Settings for Responsible AI checks.", + "id": "GoogleCloudDialogflowV2beta1RaiSettings", + "properties": { + "raiCategoryConfigs": { + "description": "Configuration for a set of RAI categories.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig": { + "description": "Configuration for a specific RAI category.", + "id": "GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig", + "properties": { + "category": { + "description": "Optional. The RAI category.", + "enum": [ + "RAI_CATEGORY_UNSPECIFIED", + "DANGEROUS_CONTENT", + "SEXUALLY_EXPLICIT", + "HARASSMENT", + "HATE_SPEECH" + ], + "enumDescriptions": [ + "Default value.", + "Dangerous content.", + "Sexually explicit content.", + "Harassment content.", + "Hate speech content." + ], + "type": "string" + }, + "sensitivityLevel": { + "description": "Optional. The sensitivity level for this category.", + "enum": [ + "SENSITIVITY_LEVEL_UNSPECIFIED", + "BLOCK_MOST", + "BLOCK_SOME", + "BLOCK_FEW", + "BLOCK_NONE" + ], + "enumDescriptions": [ + "Default value. If unspecified, the default behavior is: - DANGEROUS_CONTENT: BLOCK_FEW - SEXUALLY_EXPLICIT: BLOCK_SOME - HARASSMENT: BLOCK_SOME - HATE_SPEECH: BLOCK_SOME", + "Block most potentially sensitive responses.", + "Block some potentially sensitive responses.", + "Block a few potentially sensitive responses.", + "No filtering for this category." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1ReloadDocumentRequest": { "description": "Request message for Documents.ReloadDocument.", "id": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest", @@ -23023,6 +23599,22 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestionDedupingConfig": { + "description": "Config for suggestion deduping. NEXT_ID: 3", + "id": "GoogleCloudDialogflowV2beta1SuggestionDedupingConfig", + "properties": { + "enableDeduping": { + "description": "Optional. Whether to enable suggestion deduping.", + "type": "boolean" + }, + "similarityThreshold": { + "description": "Optional. The threshold for similarity between two suggestions. Acceptable value is [0.0, 1.0], default to 0.8", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer": { "description": "Represents suggested answer from \"frequently asked questions\".", "id": "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer", @@ -23090,11 +23682,27 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1SuggestionInput": { - "description": "Represents the selection of a suggestion.", + "description": "Represents the action to take for a tool call that requires confirmation.", "id": "GoogleCloudDialogflowV2beta1SuggestionInput", "properties": { + "action": { + "description": "Optional. The type of action to take with the tool.", + "enum": [ + "ACTION_UNSPECIFIED", + "CANCEL", + "REVISE", + "CONFIRM" + ], + "enumDescriptions": [ + "Action not specified.", + "Indicates the user chooses to not make the tool call. It is only applicable to tool calls that are waiting for user confirmation.", + "Makes the tool call with provided parameters. This action is intended for tool calls that only read but not write data.", + "Makes the tool call with provided parameters. This action is intended for tool calls that may write data." + ], + "type": "string" + }, "answerRecord": { - "description": "Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string.", + "description": "Required. Format: `projects//locations//answerRecords/` The answer record associated with the tool call.", "type": "string" }, "intentInput": { @@ -23106,9 +23714,14 @@ "description": "Properties of the object.", "type": "any" }, - "description": "In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", + "description": "Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.", "type": "object" }, + "sendTime": { + "description": "Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.", + "format": "google-datetime", + "type": "string" + }, "textOverride": { "$ref": "GoogleCloudDialogflowV2beta1TextInput", "description": "Optional. If the customer edited the suggestion before using it, include the revised text here." @@ -23770,6 +24383,10 @@ "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, + "answerRecord": { + "description": "Optional. The answer record associated with this tool call.", + "type": "string" + }, "createTime": { "description": "Output only. Create time of the tool call.", "format": "google-datetime", @@ -23784,9 +24401,32 @@ "description": "Optional. The action's input parameters.", "type": "object" }, + "state": { + "description": "Output only. State of the tool call", + "enum": [ + "STATE_UNSPECIFIED", + "TRIGGERED", + "NEEDS_CONFIRMATION" + ], + "enumDescriptions": [ + "Default value.", + "The tool call has been triggered.", + "The tool call requires confirmation from a human." + ], + "readOnly": true, + "type": "string" + }, "tool": { "description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" + }, + "toolDisplayDetails": { + "description": "Optional. A human readable description of the tool.", + "type": "string" + }, + "toolDisplayName": { + "description": "Optional. A human readable short name of the tool, to be shown on the UI.", + "type": "string" } }, "type": "object" @@ -23799,6 +24439,10 @@ "description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, + "answerRecord": { + "description": "Optional. The answer record associated with this tool call result.", + "type": "string" + }, "content": { "description": "Only populated if the response content is utf-8 encoded.", "type": "string" @@ -24202,6 +24846,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/dialogflow/v2beta1/dialogflow-gen.go b/dialogflow/v2beta1/dialogflow-gen.go index 100d354dd43..a71b5a96009 100644 --- a/dialogflow/v2beta1/dialogflow-gen.go +++ b/dialogflow/v2beta1/dialogflow-gen.go @@ -7816,6 +7816,293 @@ func (s GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig) MarshalJSON return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2AgentCoachingInstruction: Agent Coaching instructions +// that customer can configure. +type GoogleCloudDialogflowV2AgentCoachingInstruction struct { + // AgentAction: Optional. The action that human agent should take. For example, + // "apologize for the slow shipping". If the users only want to use agent + // coaching for intent detection, agent_action can be empty + AgentAction string `json:"agentAction,omitempty"` + // Condition: Optional. The condition of the instruction. For example, "the + // customer wants to cancel an order". If the users want the instruction to be + // triggered unconditionally, the condition can be empty. + Condition string `json:"condition,omitempty"` + // DisplayDetails: Optional. The detailed description of this instruction. + DisplayDetails string `json:"displayDetails,omitempty"` + // DisplayName: Optional. Display name for the instruction. + DisplayName string `json:"displayName,omitempty"` + // DuplicateCheckResult: Output only. Duplication check for the + // AgentCoachingInstruction. + DuplicateCheckResult *GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult `json:"duplicateCheckResult,omitempty"` + // SystemAction: Optional. The action that system should take. For example, + // "call GetOrderTime with order_number={order number provided by the + // customer}". If the users don't have plugins or don't want to trigger + // plugins, the system_action can be empty + SystemAction string `json:"systemAction,omitempty"` + // ForceSendFields is a list of field names (e.g. "AgentAction") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AgentAction") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingInstruction) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingInstruction + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult: +// Duplication check for the suggestion. +type GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult struct { + // DuplicateSuggestions: Output only. The duplicate suggestions. + DuplicateSuggestions []*GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion `json:"duplicateSuggestions,omitempty"` + // ForceSendFields is a list of field names (e.g. "DuplicateSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DuplicateSuggestions") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateS +// uggestion: The duplicate suggestion details. +type GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion struct { + // AnswerRecord: Output only. The answer record id of the past duplicate + // suggestion. + AnswerRecord string `json:"answerRecord,omitempty"` + // SimilarityScore: Output only. The similarity score of between the past and + // current suggestion. + SimilarityScore float64 `json:"similarityScore,omitempty"` + // SuggestionIndex: Output only. The index of the duplicate suggestion in the + // past suggestion list. + SuggestionIndex int64 `json:"suggestionIndex,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion + var s1 struct { + SimilarityScore gensupport.JSONFloat64 `json:"similarityScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SimilarityScore = float64(s1.SimilarityScore) + return nil +} + +// GoogleCloudDialogflowV2AgentCoachingSuggestion: Suggestion for coaching +// agents. +type GoogleCloudDialogflowV2AgentCoachingSuggestion struct { + // AgentActionSuggestions: Optional. Suggested actions for the agent to take. + AgentActionSuggestions []*GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion `json:"agentActionSuggestions,omitempty"` + // ApplicableInstructions: Optional. Instructions applicable based on the + // current context. + ApplicableInstructions []*GoogleCloudDialogflowV2AgentCoachingInstruction `json:"applicableInstructions,omitempty"` + // SampleResponses: Optional. Sample response for the Agent. + SampleResponses []*GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse `json:"sampleResponses,omitempty"` + // ForceSendFields is a list of field names (e.g. "AgentActionSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AgentActionSuggestions") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion: Actions +// suggested for the agent. This is based on applicable instructions. +type GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion struct { + // AgentAction: Optional. The suggested action for the agent. + AgentAction string `json:"agentAction,omitempty"` + // DuplicateCheckResult: Output only. Duplicate check result for the agent + // action suggestion. + DuplicateCheckResult *GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult `json:"duplicateCheckResult,omitempty"` + // Sources: Output only. Sources for the agent action suggestion. + Sources *GoogleCloudDialogflowV2AgentCoachingSuggestionSources `json:"sources,omitempty"` + // ForceSendFields is a list of field names (e.g. "AgentAction") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AgentAction") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult: +// Duplication check for the suggestion. +type GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult struct { + // DuplicateSuggestions: Output only. The duplicate suggestions. + DuplicateSuggestions []*GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion `json:"duplicateSuggestions,omitempty"` + // ForceSendFields is a list of field names (e.g. "DuplicateSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DuplicateSuggestions") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSu +// ggestion: The duplicate suggestion details. Keeping answer_record and +// sources together as they are identifiers for duplicate suggestions. +type GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion struct { + // AnswerRecord: Output only. The answer record id of the past duplicate + // suggestion. + AnswerRecord string `json:"answerRecord,omitempty"` + // SimilarityScore: Output only. The similarity score of between the past and + // current suggestion. + SimilarityScore float64 `json:"similarityScore,omitempty"` + // Sources: Output only. Sources for the suggestion. + Sources *GoogleCloudDialogflowV2AgentCoachingSuggestionSources `json:"sources,omitempty"` + // SuggestionIndex: Output only. The index of the duplicate suggestion in the + // past suggestion list. + SuggestionIndex int64 `json:"suggestionIndex,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion + var s1 struct { + SimilarityScore gensupport.JSONFloat64 `json:"similarityScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SimilarityScore = float64(s1.SimilarityScore) + return nil +} + +// GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse: Sample +// response that the agent can use. This could be based on applicable +// instructions and ingested data from other systems. +type GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse struct { + // DuplicateCheckResult: Output only. Duplicate check result for the sample + // response. + DuplicateCheckResult *GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult `json:"duplicateCheckResult,omitempty"` + // ResponseText: Optional. Sample response for Agent in text. + ResponseText string `json:"responseText,omitempty"` + // Sources: Output only. Sources for the Sample Response. + Sources *GoogleCloudDialogflowV2AgentCoachingSuggestionSources `json:"sources,omitempty"` + // ForceSendFields is a list of field names (e.g. "DuplicateCheckResult") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DuplicateCheckResult") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2AgentCoachingSuggestionSources: Sources for the +// suggestion. +type GoogleCloudDialogflowV2AgentCoachingSuggestionSources struct { + // InstructionIndexes: Output only. Source instruction indexes for the + // suggestion. This is the index of the applicable_instructions field. + InstructionIndexes []int64 `json:"instructionIndexes,omitempty"` + // ForceSendFields is a list of field names (e.g. "InstructionIndexes") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "InstructionIndexes") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2AgentCoachingSuggestionSources) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentCoachingSuggestionSources + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2AnnotatedMessagePart: Represents a part of a message // possibly annotated with an entity. The part can be an entity or purely a // part of the message between two entities or message start/end. @@ -8756,6 +9043,8 @@ func (s GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAns // GoogleCloudDialogflowV2GeneratorSuggestion: Suggestion generated using a // Generator. type GoogleCloudDialogflowV2GeneratorSuggestion struct { + // AgentCoachingSuggestion: Optional. Suggestion to coach the agent. + AgentCoachingSuggestion *GoogleCloudDialogflowV2AgentCoachingSuggestion `json:"agentCoachingSuggestion,omitempty"` // FreeFormSuggestion: Optional. Free form suggestion. FreeFormSuggestion *GoogleCloudDialogflowV2FreeFormSuggestion `json:"freeFormSuggestion,omitempty"` // SummarySuggestion: Optional. Suggested summary. @@ -8763,15 +9052,15 @@ type GoogleCloudDialogflowV2GeneratorSuggestion struct { // ToolCallInfo: Optional. List of request and response for tool calls // executed. ToolCallInfo []*GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo `json:"toolCallInfo,omitempty"` - // ForceSendFields is a list of field names (e.g. "FreeFormSuggestion") to + // ForceSendFields is a list of field names (e.g. "AgentCoachingSuggestion") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "FreeFormSuggestion") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "AgentCoachingSuggestion") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -11149,13 +11438,27 @@ func (s GoogleCloudDialogflowV2SummarySuggestionSummarySection) MarshalJSON() ([ type GoogleCloudDialogflowV2ToolCall struct { // Action: Optional. The name of the tool's action associated with this call. Action string `json:"action,omitempty"` + // AnswerRecord: Optional. The answer record associated with this tool call. + AnswerRecord string `json:"answerRecord,omitempty"` // CreateTime: Output only. Create time of the tool call. CreateTime string `json:"createTime,omitempty"` // InputParameters: Optional. The action's input parameters. InputParameters googleapi.RawMessage `json:"inputParameters,omitempty"` + // State: Output only. State of the tool call. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. + // "TRIGGERED" - The tool call has been triggered. + // "NEEDS_CONFIRMATION" - The tool call requires confirmation from a human. + State string `json:"state,omitempty"` // Tool: Optional. The tool associated with this call. Format: // `projects//locations//tools/`. Tool string `json:"tool,omitempty"` + // ToolDisplayDetails: Optional. A human readable description of the tool. + ToolDisplayDetails string `json:"toolDisplayDetails,omitempty"` + // ToolDisplayName: Optional. A human readable short name of the tool, to be + // shown on the UI. + ToolDisplayName string `json:"toolDisplayName,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -11179,6 +11482,9 @@ func (s GoogleCloudDialogflowV2ToolCall) MarshalJSON() ([]byte, error) { type GoogleCloudDialogflowV2ToolCallResult struct { // Action: Optional. The name of the tool's action associated with this call. Action string `json:"action,omitempty"` + // AnswerRecord: Optional. The answer record associated with this tool call + // result. + AnswerRecord string `json:"answerRecord,omitempty"` // Content: Only populated if the response content is utf-8 encoded. Content string `json:"content,omitempty"` // CreateTime: Output only. Create time of the tool call result. @@ -11647,6 +11953,324 @@ func (s GoogleCloudDialogflowV2beta1AgentAssistantRecord) MarshalJSON() ([]byte, return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1AgentCoachingContext: Agent Coaching context +// that customer can configure. +type GoogleCloudDialogflowV2beta1AgentCoachingContext struct { + // Instructions: Optional. Customized instructions for agent coaching. + Instructions []*GoogleCloudDialogflowV2beta1AgentCoachingInstruction `json:"instructions,omitempty"` + // OutputLanguageCode: Optional. Output language code. + OutputLanguageCode string `json:"outputLanguageCode,omitempty"` + // OverarchingGuidance: Optional. The overarching guidance for the agent + // coaching. This should be set only for v1.5 and later versions. + OverarchingGuidance string `json:"overarchingGuidance,omitempty"` + // Version: Optional. Version of the feature. If not set, default to latest + // version. Current candidates are ["2.5"]. + Version string `json:"version,omitempty"` + // ForceSendFields is a list of field names (e.g. "Instructions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Instructions") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingContext) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingContext + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingInstruction: Agent Coaching +// instructions that customer can configure. +type GoogleCloudDialogflowV2beta1AgentCoachingInstruction struct { + // AgentAction: Optional. The action that human agent should take. For example, + // "apologize for the slow shipping". If the users only want to use agent + // coaching for intent detection, agent_action can be empty + AgentAction string `json:"agentAction,omitempty"` + // Condition: Optional. The condition of the instruction. For example, "the + // customer wants to cancel an order". If the users want the instruction to be + // triggered unconditionally, the condition can be empty. + Condition string `json:"condition,omitempty"` + // DisplayDetails: Optional. The detailed description of this instruction. + DisplayDetails string `json:"displayDetails,omitempty"` + // DisplayName: Optional. Display name for the instruction. + DisplayName string `json:"displayName,omitempty"` + // DuplicateCheckResult: Output only. Duplication check for the + // AgentCoachingInstruction. + DuplicateCheckResult *GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult `json:"duplicateCheckResult,omitempty"` + // SystemAction: Optional. The action that system should take. For example, + // "call GetOrderTime with order_number={order number provided by the + // customer}". If the users don't have plugins or don't want to trigger + // plugins, the system_action can be empty + SystemAction string `json:"systemAction,omitempty"` + // ForceSendFields is a list of field names (e.g. "AgentAction") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AgentAction") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingInstruction) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingInstruction + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult: +// Duplication check for the suggestion. +type GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult struct { + // DuplicateSuggestions: Output only. The duplicate suggestions. + DuplicateSuggestions []*GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion `json:"duplicateSuggestions,omitempty"` + // ForceSendFields is a list of field names (e.g. "DuplicateSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DuplicateSuggestions") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDupli +// cateSuggestion: The duplicate suggestion details. +type GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion struct { + // AnswerRecord: Output only. The answer record id of the past duplicate + // suggestion. + AnswerRecord string `json:"answerRecord,omitempty"` + // SimilarityScore: Output only. The similarity score of between the past and + // current suggestion. + SimilarityScore float64 `json:"similarityScore,omitempty"` + // SuggestionIndex: Output only. The index of the duplicate suggestion in the + // past suggestion list. + SuggestionIndex int64 `json:"suggestionIndex,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion + var s1 struct { + SimilarityScore gensupport.JSONFloat64 `json:"similarityScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SimilarityScore = float64(s1.SimilarityScore) + return nil +} + +// GoogleCloudDialogflowV2beta1AgentCoachingSuggestion: Suggestion for coaching +// agents. +type GoogleCloudDialogflowV2beta1AgentCoachingSuggestion struct { + // AgentActionSuggestions: Optional. Suggested actions for the agent to take. + AgentActionSuggestions []*GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion `json:"agentActionSuggestions,omitempty"` + // ApplicableInstructions: Optional. Instructions applicable based on the + // current context. + ApplicableInstructions []*GoogleCloudDialogflowV2beta1AgentCoachingInstruction `json:"applicableInstructions,omitempty"` + // SampleResponses: Optional. Sample response for the Agent. + SampleResponses []*GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse `json:"sampleResponses,omitempty"` + // ForceSendFields is a list of field names (e.g. "AgentActionSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AgentActionSuggestions") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion: +// Actions suggested for the agent. This is based on applicable instructions. +type GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion struct { + // AgentAction: Optional. The suggested action for the agent. + AgentAction string `json:"agentAction,omitempty"` + // DuplicateCheckResult: Output only. Duplicate check result for the agent + // action suggestion. + DuplicateCheckResult *GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult `json:"duplicateCheckResult,omitempty"` + // Sources: Output only. Sources for the agent action suggestion. + Sources *GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources `json:"sources,omitempty"` + // ForceSendFields is a list of field names (e.g. "AgentAction") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AgentAction") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult: +// Duplication check for the suggestion. +type GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult struct { + // DuplicateSuggestions: Output only. The duplicate suggestions. + DuplicateSuggestions []*GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion `json:"duplicateSuggestions,omitempty"` + // ForceSendFields is a list of field names (e.g. "DuplicateSuggestions") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DuplicateSuggestions") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplic +// ateSuggestion: The duplicate suggestion details. Keeping answer_record and +// sources together as they are identifiers for duplicate suggestions. +type GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion struct { + // AnswerRecord: Output only. The answer record id of the past duplicate + // suggestion. + AnswerRecord string `json:"answerRecord,omitempty"` + // SimilarityScore: Output only. The similarity score of between the past and + // current suggestion. + SimilarityScore float64 `json:"similarityScore,omitempty"` + // Sources: Output only. Sources for the suggestion. + Sources *GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources `json:"sources,omitempty"` + // SuggestionIndex: Output only. The index of the duplicate suggestion in the + // past suggestion list. + SuggestionIndex int64 `json:"suggestionIndex,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion + var s1 struct { + SimilarityScore gensupport.JSONFloat64 `json:"similarityScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SimilarityScore = float64(s1.SimilarityScore) + return nil +} + +// GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse: Sample +// response that the agent can use. This could be based on applicable +// instructions and ingested data from other systems. +type GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse struct { + // DuplicateCheckResult: Output only. Duplicate check result for the sample + // response. + DuplicateCheckResult *GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult `json:"duplicateCheckResult,omitempty"` + // ResponseText: Optional. Sample response for Agent in text. + ResponseText string `json:"responseText,omitempty"` + // Sources: Output only. Sources for the Sample Response. + Sources *GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources `json:"sources,omitempty"` + // ForceSendFields is a list of field names (e.g. "DuplicateCheckResult") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DuplicateCheckResult") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources: Sources for the +// suggestion. +type GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources struct { + // InstructionIndexes: Output only. Source instruction indexes for the + // suggestion. This is the index of the applicable_instructions field. + InstructionIndexes []int64 `json:"instructionIndexes,omitempty"` + // ForceSendFields is a list of field names (e.g. "InstructionIndexes") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "InstructionIndexes") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1AnalyzeContentRequest: The request message for // Participants.AnalyzeContent. type GoogleCloudDialogflowV2beta1AnalyzeContentRequest struct { @@ -12902,6 +13526,10 @@ func (s GoogleCloudDialogflowV2beta1ConversationContextReference) MarshalJSON() // GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent: // Contents ingested. type GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent struct { + // AnswerRecord: If the context content was generated from a tool call, specify + // the answer record associated with the tool call. Format: + // `projects//locations//answerRecords/`. + AnswerRecord string `json:"answerRecord,omitempty"` // Content: Required. The information ingested in a single request. Content string `json:"content,omitempty"` // ContentFormat: Required. The format of the ingested string. @@ -12914,13 +13542,13 @@ type GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent stru // IngestionTime: Output only. The time when this information was incorporated // into the relevant context reference. IngestionTime string `json:"ingestionTime,omitempty"` - // ForceSendFields is a list of field names (e.g. "Content") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Content") to include in API + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -14568,6 +15196,8 @@ func (s GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggesti // GoogleCloudDialogflowV2beta1Generator: LLM generator. type GoogleCloudDialogflowV2beta1Generator struct { + // AgentCoachingContext: Input of Agent Coaching feature. + AgentCoachingContext *GoogleCloudDialogflowV2beta1AgentCoachingContext `json:"agentCoachingContext,omitempty"` // CreateTime: Output only. Creation time of this generator. CreateTime string `json:"createTime,omitempty"` // Description: Optional. Human readable description of the generator. @@ -14584,6 +15214,9 @@ type GoogleCloudDialogflowV2beta1Generator struct { // Example: `text-bison` * To use a stable model version, specify the version // number as well. Example: `text-bison@002`. PublishedModel string `json:"publishedModel,omitempty"` + // SuggestionDedupingConfig: Optional. Configuration for suggestion deduping. + // This is only applicable to AI Coach feature. + SuggestionDedupingConfig *GoogleCloudDialogflowV2beta1SuggestionDedupingConfig `json:"suggestionDedupingConfig,omitempty"` // SummarizationContext: Input of Summarization feature. SummarizationContext *GoogleCloudDialogflowV2beta1SummarizationContext `json:"summarizationContext,omitempty"` // Tools: Optional. Resource names of the tools that the generator can choose @@ -14607,15 +15240,15 @@ type GoogleCloudDialogflowV2beta1Generator struct { // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "CreateTime") to + // ForceSendFields is a list of field names (e.g. "AgentCoachingContext") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CreateTime") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See + // NullFields is a list of field names (e.g. "AgentCoachingContext") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -14650,6 +15283,16 @@ type GoogleCloudDialogflowV2beta1GeneratorEvaluation struct { // Name: Output only. Identifier. The resource name of the evaluation. Format: // `projects//locations//generators// evaluations/` Name string `json:"name,omitempty"` + // SatisfiesPzi: Output only. A read only boolean field reflecting Zone + // Isolation status of the model. The field is an aggregated value of ZI status + // of its underlying dependencies. See more details in + // go/zicy-resource-placement#resource-status + SatisfiesPzi bool `json:"satisfiesPzi,omitempty"` + // SatisfiesPzs: Output only. A read only boolean field reflecting Zone + // Separation status of the model. The field is an aggregated value of ZS + // status of its underlying dependencies. See more details in + // go/zicy-resource-placement#resource-status + SatisfiesPzs bool `json:"satisfiesPzs,omitempty"` // SummarizationMetrics: Output only. Only available when the summarization // generator is provided. SummarizationMetrics *GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics `json:"summarizationMetrics,omitempty"` @@ -14854,6 +15497,8 @@ func (s GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig // GoogleCloudDialogflowV2beta1GeneratorSuggestion: Suggestion generated using // a Generator. type GoogleCloudDialogflowV2beta1GeneratorSuggestion struct { + // AgentCoachingSuggestion: Optional. Suggestion to coach the agent. + AgentCoachingSuggestion *GoogleCloudDialogflowV2beta1AgentCoachingSuggestion `json:"agentCoachingSuggestion,omitempty"` // FreeFormSuggestion: Optional. Free form suggestion. FreeFormSuggestion *GoogleCloudDialogflowV2beta1FreeFormSuggestion `json:"freeFormSuggestion,omitempty"` // SummarySuggestion: Optional. Suggested summary. @@ -14861,15 +15506,15 @@ type GoogleCloudDialogflowV2beta1GeneratorSuggestion struct { // ToolCallInfo: Optional. List of request and response for tool calls // executed. ToolCallInfo []*GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo `json:"toolCallInfo,omitempty"` - // ForceSendFields is a list of field names (e.g. "FreeFormSuggestion") to + // ForceSendFields is a list of field names (e.g. "AgentCoachingSuggestion") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "FreeFormSuggestion") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "AgentCoachingSuggestion") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -15047,6 +15692,9 @@ type GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig struc // from high latency features in Pub/Sub. High latency feature(s): // KNOWLEDGE_ASSIST DisableHighLatencyFeaturesSyncDelivery bool `json:"disableHighLatencyFeaturesSyncDelivery,omitempty"` + // EnableAsyncToolCall: Optional. If true, enable asynchronous execution of + // tools. + EnableAsyncToolCall bool `json:"enableAsyncToolCall,omitempty"` // FeatureConfigs: Configuration of different suggestion features. One feature // can have only one config. FeatureConfigs []*GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionFeatureConfig `json:"featureConfigs,omitempty"` @@ -15063,6 +15711,16 @@ type GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig struc // will be grouped into a single Pub/Sub event or // StreamingAnalyzeContentResponse. GroupSuggestionResponses bool `json:"groupSuggestionResponses,omitempty"` + // SkipEmptyEventBasedSuggestion: Optional. Enable skipping event based + // suggestion if the suggestion is empty. For example, with this field + // disabled, Knowledge Assist feature sends a Pub/Sub message when there are no + // suggestions. Enabling this field will change the behavior to skip the + // Pub/Sub message in this situation. + SkipEmptyEventBasedSuggestion bool `json:"skipEmptyEventBasedSuggestion,omitempty"` + // UseUnredactedConversationData: Optional. If true, use unredacted transcript + // data (Supported features: AI_COACH) and use unredacted ingested context + // (Supported features: All Agent Assist features) + UseUnredactedConversationData bool `json:"useUnredactedConversationData,omitempty"` // ForceSendFields is a list of field names (e.g. // "DisableHighLatencyFeaturesSyncDelivery") to unconditionally include in API // requests. By default, fields with empty or default values are omitted from @@ -15110,8 +15768,18 @@ type GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionFeatureConfi // we can't find its answer. By default, queries are suggested only if we find // its answer. Supported features: KNOWLEDGE_ASSIST EnableQuerySuggestionWhenNoAnswer bool `json:"enableQuerySuggestionWhenNoAnswer,omitempty"` + // EnableResponseDebugInfo: Optional. Enable returning detailed reasons for + // suggestion results. For example, with this field disabled, Knowledge Search + // feature returns NotFound error when no answer is found for the input query. + // Enabling this field will change the behavior to return an OK response with + // detailed information indicating the lack of results. Supported features: + // KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST + EnableResponseDebugInfo bool `json:"enableResponseDebugInfo,omitempty"` // QueryConfig: Configs of query. QueryConfig *GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig `json:"queryConfig,omitempty"` + // RaiSettings: Optional. Settings for Responsible AI checks. Supported + // features: KNOWLEDGE_ASSIST + RaiSettings *GoogleCloudDialogflowV2beta1RaiSettings `json:"raiSettings,omitempty"` // SuggestionFeature: The suggestion feature. SuggestionFeature *GoogleCloudDialogflowV2beta1SuggestionFeature `json:"suggestionFeature,omitempty"` // SuggestionTriggerSettings: Settings of suggestion trigger. Currently, only @@ -19098,6 +19766,69 @@ func (s *GoogleCloudDialogflowV2beta1QueryResult) UnmarshalJSON(data []byte) err return nil } +// GoogleCloudDialogflowV2beta1RaiSettings: Settings for Responsible AI checks. +type GoogleCloudDialogflowV2beta1RaiSettings struct { + // RaiCategoryConfigs: Configuration for a set of RAI categories. + RaiCategoryConfigs []*GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig `json:"raiCategoryConfigs,omitempty"` + // ForceSendFields is a list of field names (e.g. "RaiCategoryConfigs") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "RaiCategoryConfigs") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1RaiSettings) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1RaiSettings + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig: Configuration for +// a specific RAI category. +type GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig struct { + // Category: Optional. The RAI category. + // + // Possible values: + // "RAI_CATEGORY_UNSPECIFIED" - Default value. + // "DANGEROUS_CONTENT" - Dangerous content. + // "SEXUALLY_EXPLICIT" - Sexually explicit content. + // "HARASSMENT" - Harassment content. + // "HATE_SPEECH" - Hate speech content. + Category string `json:"category,omitempty"` + // SensitivityLevel: Optional. The sensitivity level for this category. + // + // Possible values: + // "SENSITIVITY_LEVEL_UNSPECIFIED" - Default value. If unspecified, the + // default behavior is: - DANGEROUS_CONTENT: BLOCK_FEW - SEXUALLY_EXPLICIT: + // BLOCK_SOME - HARASSMENT: BLOCK_SOME - HATE_SPEECH: BLOCK_SOME + // "BLOCK_MOST" - Block most potentially sensitive responses. + // "BLOCK_SOME" - Block some potentially sensitive responses. + // "BLOCK_FEW" - Block a few potentially sensitive responses. + // "BLOCK_NONE" - No filtering for this category. + SensitivityLevel string `json:"sensitivityLevel,omitempty"` + // ForceSendFields is a list of field names (e.g. "Category") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Category") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1RaiSettingsRaiCategoryConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1ReloadDocumentRequest: Request message for // Documents.ReloadDocument. type GoogleCloudDialogflowV2beta1ReloadDocumentRequest struct { @@ -20962,6 +21693,46 @@ func (s GoogleCloudDialogflowV2beta1SuggestionArticle) MarshalJSON() ([]byte, er return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestionDedupingConfig: Config for suggestion +// deduping. NEXT_ID: 3 +type GoogleCloudDialogflowV2beta1SuggestionDedupingConfig struct { + // EnableDeduping: Optional. Whether to enable suggestion deduping. + EnableDeduping bool `json:"enableDeduping,omitempty"` + // SimilarityThreshold: Optional. The threshold for similarity between two + // suggestions. Acceptable value is [0.0, 1.0], default to 0.8 + SimilarityThreshold float64 `json:"similarityThreshold,omitempty"` + // ForceSendFields is a list of field names (e.g. "EnableDeduping") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EnableDeduping") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDialogflowV2beta1SuggestionDedupingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestionDedupingConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDialogflowV2beta1SuggestionDedupingConfig) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDialogflowV2beta1SuggestionDedupingConfig + var s1 struct { + SimilarityThreshold gensupport.JSONFloat64 `json:"similarityThreshold"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SimilarityThreshold = float64(s1.SimilarityThreshold) + return nil +} + // GoogleCloudDialogflowV2beta1SuggestionFaqAnswer: Represents suggested answer // from "frequently asked questions". type GoogleCloudDialogflowV2beta1SuggestionFaqAnswer struct { @@ -21054,40 +21825,42 @@ func (s GoogleCloudDialogflowV2beta1SuggestionFeature) MarshalJSON() ([]byte, er return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDialogflowV2beta1SuggestionInput: Represents the selection of a -// suggestion. +// GoogleCloudDialogflowV2beta1SuggestionInput: Represents the action to take +// for a tool call that requires confirmation. type GoogleCloudDialogflowV2beta1SuggestionInput struct { - // AnswerRecord: Required. The ID of a suggestion selected by the human agent. - // The suggestion(s) were generated in a previous call to request Dialogflow - // assist. The format is: `projects//locations//answerRecords/` where is an - // alphanumeric string. + // Action: Optional. The type of action to take with the tool. + // + // Possible values: + // "ACTION_UNSPECIFIED" - Action not specified. + // "CANCEL" - Indicates the user chooses to not make the tool call. It is + // only applicable to tool calls that are waiting for user confirmation. + // "REVISE" - Makes the tool call with provided parameters. This action is + // intended for tool calls that only read but not write data. + // "CONFIRM" - Makes the tool call with provided parameters. This action is + // intended for tool calls that may write data. + Action string `json:"action,omitempty"` + // AnswerRecord: Required. Format: `projects//locations//answerRecords/` The + // answer record associated with the tool call. AnswerRecord string `json:"answerRecord,omitempty"` // IntentInput: The intent to be triggered on V3 agent. IntentInput *GoogleCloudDialogflowV2beta1IntentInput `json:"intentInput,omitempty"` - // Parameters: In Dialogflow assist for v3, the user can submit a form by - // sending a SuggestionInput. The form is uniquely determined by the - // answer_record field, which identifies a v3 QueryResult containing the - // current page. The form parameters are specified via the parameters field. - // Depending on your protocol or client library language, this is a map, - // associative array, symbol table, dictionary, or JSON object composed of a - // collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey - // value: parameter name * MapValue type: If parameter's entity type is a - // composite entity then use map, otherwise, depending on the parameter value - // type, it could be one of string, number, boolean, null, list or map. * - // MapValue value: If parameter's entity type is a composite entity then use - // map from composite entity property names to property values, otherwise, use - // parameter value. + // Parameters: Parameters to be used for the tool call. If not provided, the + // tool will be called without any parameters. Parameters googleapi.RawMessage `json:"parameters,omitempty"` + // SendTime: Optional. Time when the current suggest input is sent. For tool + // calls, this timestamp (along with the answer record) will be included in the + // corresponding tool call result so that it can be identified. + SendTime string `json:"sendTime,omitempty"` // TextOverride: Optional. If the customer edited the suggestion before using // it, include the revised text here. TextOverride *GoogleCloudDialogflowV2beta1TextInput `json:"textOverride,omitempty"` - // ForceSendFields is a list of field names (e.g. "AnswerRecord") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. "Action") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // NullFields is a list of field names (e.g. "Action") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -21930,13 +22703,27 @@ func (s GoogleCloudDialogflowV2beta1TextToSpeechSettings) MarshalJSON() ([]byte, type GoogleCloudDialogflowV2beta1ToolCall struct { // Action: Optional. The name of the tool's action associated with this call. Action string `json:"action,omitempty"` + // AnswerRecord: Optional. The answer record associated with this tool call. + AnswerRecord string `json:"answerRecord,omitempty"` // CreateTime: Output only. Create time of the tool call. CreateTime string `json:"createTime,omitempty"` // InputParameters: Optional. The action's input parameters. InputParameters googleapi.RawMessage `json:"inputParameters,omitempty"` + // State: Output only. State of the tool call + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. + // "TRIGGERED" - The tool call has been triggered. + // "NEEDS_CONFIRMATION" - The tool call requires confirmation from a human. + State string `json:"state,omitempty"` // Tool: Optional. The tool associated with this call. Format: // `projects//locations//tools/`. Tool string `json:"tool,omitempty"` + // ToolDisplayDetails: Optional. A human readable description of the tool. + ToolDisplayDetails string `json:"toolDisplayDetails,omitempty"` + // ToolDisplayName: Optional. A human readable short name of the tool, to be + // shown on the UI. + ToolDisplayName string `json:"toolDisplayName,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -21960,6 +22747,9 @@ func (s GoogleCloudDialogflowV2beta1ToolCall) MarshalJSON() ([]byte, error) { type GoogleCloudDialogflowV2beta1ToolCallResult struct { // Action: Optional. The name of the tool's action associated with this call. Action string `json:"action,omitempty"` + // AnswerRecord: Optional. The answer record associated with this tool call + // result. + AnswerRecord string `json:"answerRecord,omitempty"` // Content: Only populated if the response content is utf-8 encoded. Content string `json:"content,omitempty"` // CreateTime: Output only. Create time of the tool call result. @@ -22465,6 +23255,11 @@ type GoogleLongrunningListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -51546,6 +52341,19 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -53284,6 +54092,19 @@ func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperat return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *ProjectsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/firebaseml/v2beta/firebaseml-api.json b/firebaseml/v2beta/firebaseml-api.json index 02e2de34af2..ff4590214c3 100644 --- a/firebaseml/v2beta/firebaseml-api.json +++ b/firebaseml/v2beta/firebaseml-api.json @@ -206,7 +206,7 @@ } } }, - "revision": "20250929", + "revision": "20250930", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -460,7 +460,8 @@ "IMAGE_PROHIBITED_CONTENT", "IMAGE_RECITATION", "IMAGE_OTHER", - "UNEXPECTED_TOOL_CALL" + "UNEXPECTED_TOOL_CALL", + "NO_IMAGE" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -478,7 +479,8 @@ "Image generation stopped because generated images has other prohibited content.", "Image generation stopped due to recitation.", "Image generation stopped because of other miscellaneous issue.", - "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration)." + "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", + "The model was expected to generate an image, but none was generated." ], "readOnly": true, "type": "string" @@ -1207,6 +1209,10 @@ "format": "float", "type": "number" }, + "imageConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ImageConfig", + "description": "Optional. Config for image generation features." + }, "logprobs": { "description": "Optional. Logit probabilities.", "format": "int32", @@ -1655,6 +1661,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ImageConfig": { + "description": "Config for image generation features.", + "id": "GoogleCloudAiplatformV1beta1ImageConfig", + "properties": { + "aspectRatio": { + "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1LogprobsResult": { "description": "Logprobs Result", "id": "GoogleCloudAiplatformV1beta1LogprobsResult", diff --git a/firebaseml/v2beta/firebaseml-gen.go b/firebaseml/v2beta/firebaseml-gen.go index 0cdfbba36b6..e506f284f69 100644 --- a/firebaseml/v2beta/firebaseml-gen.go +++ b/firebaseml/v2beta/firebaseml-gen.go @@ -575,6 +575,8 @@ type GoogleCloudAiplatformV1beta1Candidate struct { // "UNEXPECTED_TOOL_CALL" - The function call generated by the model is // semantically invalid (e.g. a function call is generated when function // calling is not enabled or the function is not in the function declaration). + // "NO_IMAGE" - The model was expected to generate an image, but none was + // generated. FinishReason string `json:"finishReason,omitempty"` // GroundingMetadata: Output only. Metadata specifies sources used to ground // generated content. @@ -1430,6 +1432,8 @@ type GoogleCloudAiplatformV1beta1GenerationConfig struct { EnableAffectiveDialog bool `json:"enableAffectiveDialog,omitempty"` // FrequencyPenalty: Optional. Frequency penalties. FrequencyPenalty float64 `json:"frequencyPenalty,omitempty"` + // ImageConfig: Optional. Config for image generation features. + ImageConfig *GoogleCloudAiplatformV1beta1ImageConfig `json:"imageConfig,omitempty"` // Logprobs: Optional. Logit probabilities. Logprobs int64 `json:"logprobs,omitempty"` // MaxOutputTokens: Optional. The maximum number of output tokens to generate @@ -2018,6 +2022,31 @@ func (s *GoogleCloudAiplatformV1beta1GroundingSupport) UnmarshalJSON(data []byte return nil } +// GoogleCloudAiplatformV1beta1ImageConfig: Config for image generation +// features. +type GoogleCloudAiplatformV1beta1ImageConfig struct { + // AspectRatio: Optional. The desired aspect ratio for the generated images. + // The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" + // "4:5", "5:4" "9:16", "16:9" "21:9" + AspectRatio string `json:"aspectRatio,omitempty"` + // ForceSendFields is a list of field names (e.g. "AspectRatio") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AspectRatio") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1ImageConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1ImageConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudAiplatformV1beta1LogprobsResult: Logprobs Result type GoogleCloudAiplatformV1beta1LogprobsResult struct { // ChosenCandidates: Length = total number of decoding steps. The chosen diff --git a/healthcare/v1/healthcare-api.json b/healthcare/v1/healthcare-api.json index a4f63388228..61bedae8096 100644 --- a/healthcare/v1/healthcare-api.json +++ b/healthcare/v1/healthcare-api.json @@ -2022,7 +2022,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -2056,7 +2056,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -2090,7 +2090,7 @@ ] }, "searchForStudies": { - "description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -2182,7 +2182,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -2412,7 +2412,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", + "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -2446,7 +2446,7 @@ ] }, "retrieveStudy": { - "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", + "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -2480,7 +2480,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -2514,7 +2514,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -2548,7 +2548,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -2623,7 +2623,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", + "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -2657,7 +2657,7 @@ ] }, "retrieveSeries": { - "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", + "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -2691,7 +2691,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -2763,7 +2763,7 @@ ] }, "retrieveInstance": { - "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", + "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -2797,7 +2797,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", + "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -2831,7 +2831,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", + "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -2874,7 +2874,7 @@ "bulkdata": { "methods": { "retrieveBulkdata": { - "description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", + "description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.retrieveBulkdata", @@ -2912,7 +2912,7 @@ "frames": { "methods": { "retrieveFrames": { - "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", + "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -2946,7 +2946,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", + "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -5132,7 +5132,7 @@ } } }, - "revision": "20250904", + "revision": "20250923", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6140,7 +6140,7 @@ "enumDescriptions": [ "No tag filtration profile provided. Same as KEEP_ALL_PROFILE.", "Keep only tags required to produce valid DICOM.", - "Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", + "Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", "Keep all tags.", "Inspects within tag contents and replaces sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" ], @@ -6155,7 +6155,7 @@ "description": "List of tags to remove. Keep all other tags." }, "skipIdRedaction": { - "description": "Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", + "description": "Optional. If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", "type": "boolean" } }, @@ -8716,7 +8716,7 @@ "id": "TagFilterList", "properties": { "tags": { - "description": "Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example \"PatientID\", \"00100010\".", + "description": "Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example \"PatientID\", \"00100010\".", "items": { "type": "string" }, diff --git a/healthcare/v1/healthcare-gen.go b/healthcare/v1/healthcare-gen.go index 953a8a65d2b..290256c6fa8 100644 --- a/healthcare/v1/healthcare-gen.go +++ b/healthcare/v1/healthcare-gen.go @@ -2056,7 +2056,7 @@ type DicomConfig struct { // "ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE" - Remove tags based on DICOM // Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition // 2018e) - // http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. + // https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. // "KEEP_ALL_PROFILE" - Keep all tags. // "DEIDENTIFY_TAG_CONTENTS" - Inspects within tag contents and replaces // sensitive text. The process can be configured using the TextConfig. Applies @@ -2074,7 +2074,7 @@ type DicomConfig struct { // directly to an individual out of context, given access to the original // images, or to a database of the original images containing the UIDs, it // would be possible to recover the individual's identity." - // http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + // https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html SkipIdRedaction bool `json:"skipIdRedaction,omitempty"` // ForceSendFields is a list of field names (e.g. "FilterProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -6170,7 +6170,7 @@ func (s StudyMetrics) MarshalJSON() ([]byte, error) { type TagFilterList struct { // Tags: Optional. Tags to be filtered. Tags must be DICOM Data Elements, File // Meta Elements, or Directory Structuring Elements, as defined at: - // http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. + // https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. // They may be provided by "Keyword" or "Tag". For example "PatientID", // "00100010". Tags []string `json:"tags,omitempty"` @@ -13703,7 +13703,7 @@ type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall struct { // SearchForInstances: SearchForInstances returns a list of matching instances. // See [Search Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). // For details on the implementation of SearchForInstances, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -13795,7 +13795,7 @@ type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall struct { // SearchForSeries: SearchForSeries returns a list of matching series. See // [Search Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). // For details on the implementation of SearchForSeries, see Search transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -13885,7 +13885,7 @@ type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall struct { // SearchForStudies: SearchForStudies returns a list of matching studies. See // [Search Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). // For details on the implementation of SearchForStudies, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -14198,7 +14198,7 @@ type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall struct { // StoreInstances: StoreInstances stores DICOM instances associated with study // instance unique identifiers (SUID). See [Store Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). // For details on the implementation of StoreInstances, see Store transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -14952,7 +14952,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall struct { // RetrieveMetadata: RetrieveStudyMetadata returns instance associated with the // given study presented as metadata. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveStudyMetadata, see Metadata // resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the @@ -15043,7 +15043,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall struct { // RetrieveStudy: RetrieveStudy returns all instances within the given study. // See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveStudy, see DICOM // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) @@ -15134,7 +15134,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall struct { // SearchForInstances: SearchForInstances returns a list of matching instances. // See [Search Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). // For details on the implementation of SearchForInstances, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -15226,7 +15226,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall struct { // SearchForSeries: SearchForSeries returns a list of matching series. See // [Search Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). // For details on the implementation of SearchForSeries, see Search transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -15316,7 +15316,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall struct { // StoreInstances: StoreInstances stores DICOM instances associated with study // instance unique identifiers (SUID). See [Store Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). // For details on the implementation of StoreInstances, see Store transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -15510,7 +15510,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall struc // RetrieveMetadata: RetrieveSeriesMetadata returns instance associated with // the given study and series, presented as metadata. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveSeriesMetadata, see Metadata // resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the @@ -15601,7 +15601,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall struct // RetrieveSeries: RetrieveSeries returns all instances within the given study // and series. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveSeries, see DICOM // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) @@ -15692,7 +15692,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall str // SearchForInstances: SearchForInstances returns a list of matching instances. // See [Search Transaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). // For details on the implementation of SearchForInstances, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -15894,7 +15894,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceC // RetrieveInstance: RetrieveInstance returns instance associated with the // given study, series, and SOP Instance UID. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveInstance, see DICOM // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) @@ -15989,7 +15989,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataC // RetrieveMetadata: RetrieveInstanceMetadata returns instance associated with // the given study, series, and SOP Instance UID presented as metadata. See // [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveInstanceMetadata, see Metadata // resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the @@ -16083,7 +16083,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedC // RetrieveRendered: RetrieveRenderedInstance returns instance associated with // the given study, series, and SOP Instance UID in an acceptable Rendered // Media Type. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveRenderedInstance, see Rendered // resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the @@ -16184,7 +16184,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesBulkdataRetrieveB // RetrieveBulkdata: Returns uncompressed, unencoded bytes representing the // referenced bulkdata tag from an instance. See Retrieve Transaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveBulkdata, see Bulkdata // resources // (https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the @@ -16277,7 +16277,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFra // RetrieveFrames: RetrieveFrames returns instances associated with the given // study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. // For details on the implementation of RetrieveFrames, see DICOM frames // (https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud // Healthcare API conformance statement. For samples that show how to call @@ -16370,7 +16370,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRen // RetrieveRendered: RetrieveRenderedFrames returns instances associated with // the given study, series, SOP Instance UID and frame numbers in an acceptable // Rendered Media Type. See [RetrieveTransaction] -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveRenderedFrames, see Rendered // resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the diff --git a/healthcare/v1beta1/healthcare-api.json b/healthcare/v1beta1/healthcare-api.json index 412fa868484..f31d69a5233 100644 --- a/healthcare/v1beta1/healthcare-api.json +++ b/healthcare/v1beta1/healthcare-api.json @@ -2022,7 +2022,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -2056,7 +2056,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -2090,7 +2090,7 @@ ] }, "searchForStudies": { - "description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -2182,7 +2182,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -2449,7 +2449,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", + "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -2483,7 +2483,7 @@ ] }, "retrieveStudy": { - "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", + "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -2517,7 +2517,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -2551,7 +2551,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -2585,7 +2585,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -2734,7 +2734,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", + "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -2768,7 +2768,7 @@ ] }, "retrieveSeries": { - "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", + "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -2802,7 +2802,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", + "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -2911,7 +2911,7 @@ ] }, "retrieveInstance": { - "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", + "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -2945,7 +2945,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", + "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -2979,7 +2979,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", + "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -3059,7 +3059,7 @@ "bulkdata": { "methods": { "retrieveBulkdata": { - "description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", + "description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.retrieveBulkdata", @@ -3097,7 +3097,7 @@ "frames": { "methods": { "retrieveFrames": { - "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", + "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -3131,7 +3131,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", + "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -5679,7 +5679,7 @@ } } }, - "revision": "20250904", + "revision": "20250923", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5711,7 +5711,7 @@ "properties": { "cleanImageTag": { "$ref": "ImageConfig", - "description": "Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData" + "description": "Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to `Keep`. Supported [tags](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): PixelData" }, "cleanTextTag": { "$ref": "CleanTextTag", @@ -5734,11 +5734,11 @@ }, "recurseTag": { "$ref": "RecurseTag", - "description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ" + "description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ" }, "regenUidTag": { "$ref": "RegenUidTag", - "description": "Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI" + "description": "Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI" }, "removeTag": { "$ref": "RemoveTag", @@ -6270,7 +6270,7 @@ "type": "object" }, "CleanDescriptorsOption": { - "description": "This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token \"[CTX]\". This option uses an additional infoType during inspection.", + "description": "This option is based on the DICOM Standard's [Clean Descriptors Option](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token \"[CTX]\". This option uses an additional infoType during inspection.", "id": "CleanDescriptorsOption", "properties": {}, "type": "object" @@ -6282,7 +6282,7 @@ "type": "object" }, "CleanTextTag": { - "description": "Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS", + "description": "Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS", "id": "CleanTextTag", "properties": {}, "type": "object" @@ -6839,7 +6839,7 @@ "enumDescriptions": [ "No tag filtration profile provided. Same as KEEP_ALL_PROFILE.", "Keep only the tags required to produce valid DICOM objects.", - "Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", + "Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.", "Keep all tags.", "Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" ], @@ -6854,7 +6854,7 @@ "description": "List of tags to remove. Keep all other tags." }, "skipIdRedaction": { - "description": "If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", + "description": "If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: \"Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity.\" https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html", "type": "boolean" } }, @@ -6981,9 +6981,9 @@ "enumDescriptions": [ "No profile provided. Same as `ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE`.", "Keep only the tags required to produce valid DICOM objects.", - "Remove tags based on DICOM Standard's [Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e)](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html).", + "Remove tags based on DICOM Standard's [Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e)](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html).", "Keep all tags.", - "Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" + "Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS" ], "type": "string" } @@ -8903,10 +8903,10 @@ }, "cleanImage": { "$ref": "ImageConfig", - "description": "Apply `Action.clean_image` to [`PixelData`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured." + "description": "Apply `Action.clean_image` to [`PixelData`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) as configured." }, "primaryIds": { - "description": "Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html).", + "description": "Set `Action` for [`StudyInstanceUID`, `SeriesInstanceUID`, `SOPInstanceUID`, and `MediaStorageSOPInstanceUID`](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html).", "enum": [ "PRIMARY_IDS_OPTION_UNSPECIFIED", "KEEP", @@ -9114,7 +9114,7 @@ "type": "object" }, "RecurseTag": { - "description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ", + "description": "Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ", "id": "RecurseTag", "properties": {}, "type": "object" @@ -9126,7 +9126,7 @@ "type": "object" }, "RegenUidTag": { - "description": "Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI", + "description": "Replace UID with a new generated UID. Supported [Value Representation] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI", "id": "RegenUidTag", "properties": {}, "type": "object" @@ -9799,7 +9799,7 @@ "id": "TagFilterList", "properties": { "tags": { - "description": "Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example, \"PatientID\", \"00100010\".", + "description": "Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by \"Keyword\" or \"Tag\". For example, \"PatientID\", \"00100010\".", "items": { "type": "string" }, diff --git a/healthcare/v1beta1/healthcare-gen.go b/healthcare/v1beta1/healthcare-gen.go index b48c5a52e6a..0e7c547871b 100644 --- a/healthcare/v1beta1/healthcare-gen.go +++ b/healthcare/v1beta1/healthcare-gen.go @@ -534,7 +534,7 @@ type Action struct { // CleanImageTag: Inspect image and transform sensitive burnt-in text. Doesn't // apply to elements nested in a sequence, which revert to `Keep`. Supported // tags - // (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): + // (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html): // PixelData CleanImageTag *ImageConfig `json:"cleanImageTag,omitempty"` // CleanTextTag: Inspect text and transform sensitive text. Configurable via @@ -551,12 +551,12 @@ type Action struct { Queries []string `json:"queries,omitempty"` // RecurseTag: Recursively apply DICOM de-id to tags nested in a sequence. // Supported [Value Representation] - // (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): + // (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): // SQ RecurseTag *RecurseTag `json:"recurseTag,omitempty"` // RegenUidTag: Replace UID with a new generated UID. Supported [Value // Representation] - // (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): + // (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): // UI RegenUidTag *RegenUidTag `json:"regenUidTag,omitempty"` // RemoveTag: Replace with empty tag. @@ -1418,11 +1418,11 @@ func (s CheckDataAccessResponse) MarshalJSON() ([]byte, error) { // CleanDescriptorsOption: This option is based on the DICOM Standard's Clean // Descriptors Option -// (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), +// (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), // and the `CleanText` `Action` is applied to all the specified fields. When // cleaning text, the process attempts to transform phrases matching any of the // tags marked for removal (action codes D, Z, X, and U) in the Basic Profile -// (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). +// (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). // These contextual phrases are replaced with the token "[CTX]". This option // uses an additional infoType during inspection. type CleanDescriptorsOption struct { @@ -1437,7 +1437,7 @@ type CleanTextField struct { // CleanTextTag: Inspect text and transform sensitive text. Configurable using // TextConfig. Supported [Value Representations] -// (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): +// (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): // AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS type CleanTextTag struct { } @@ -2251,7 +2251,7 @@ type DicomConfig struct { // "ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE" - Remove tags based on DICOM // Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition // 2018e) - // http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. + // https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. // "KEEP_ALL_PROFILE" - Keep all tags. // "DEIDENTIFY_TAG_CONTENTS" - Inspect within tag contents and replace // sensitive text. The process can be configured using the TextConfig. Applies @@ -2269,7 +2269,7 @@ type DicomConfig struct { // directly to an individual out of context, given access to the original // images, or to a database of the original images containing the UIDs, it // would be possible to recover the individual's identity." - // http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + // https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html SkipIdRedaction bool `json:"skipIdRedaction,omitempty"` // ForceSendFields is a list of field names (e.g. "FilterProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -2477,13 +2477,13 @@ type DicomTagConfig struct { // DICOM objects. // "ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE" - Remove tags based on DICOM // Standard's [Attribute Confidentiality Basic Profile (DICOM Standard Edition - // 2018e)](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter - // _E.html). + // 2018e)](https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapte + // r_E.html). // "KEEP_ALL_PROFILE" - Keep all tags. // "DEIDENTIFY_TAG_CONTENTS" - Inspect tag contents and replace sensitive // text. The process can be configured using the TextConfig. Applies to all // tags with the following [Value Representations] - // (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): + // (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): // AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS ProfileType string `json:"profileType,omitempty"` // ForceSendFields is a list of field names (e.g. "Actions") to unconditionally @@ -5546,12 +5546,12 @@ type Options struct { // CleanDescriptors: Set Clean Descriptors Option. CleanDescriptors *CleanDescriptorsOption `json:"cleanDescriptors,omitempty"` // CleanImage: Apply `Action.clean_image` to `PixelData` - // (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) + // (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html) // as configured. CleanImage *ImageConfig `json:"cleanImage,omitempty"` // PrimaryIds: Set `Action` for `StudyInstanceUID`, `SeriesInstanceUID`, // `SOPInstanceUID`, and `MediaStorageSOPInstanceUID` - // (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). + // (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part06/chapter_6.html). // // Possible values: // "PRIMARY_IDS_OPTION_UNSPECIFIED" - No value provided. Default to the @@ -5920,7 +5920,7 @@ func (s QueryAccessibleDataResponse) MarshalJSON() ([]byte, error) { // RecurseTag: Recursively apply DICOM de-id to tags nested in a sequence. // Supported [Value Representation] -// (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): +// (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): // SQ type RecurseTag struct { } @@ -5932,7 +5932,7 @@ type RedactConfig struct { // RegenUidTag: Replace UID with a new generated UID. Supported [Value // Representation] -// (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): +// (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): // UI type RegenUidTag struct { } @@ -6913,7 +6913,7 @@ func (s StudyMetrics) MarshalJSON() ([]byte, error) { type TagFilterList struct { // Tags: Tags to be filtered. Tags must be DICOM Data Elements, File Meta // Elements, or Directory Structuring Elements, as defined at: - // http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. + // https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. // They may be provided by "Keyword" or "Tag". For example, "PatientID", // "00100010". Tags []string `json:"tags,omitempty"` @@ -14506,7 +14506,7 @@ type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall struct { // SearchForInstances: SearchForInstances returns a list of matching instances. // See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of SearchForInstances, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -14598,7 +14598,7 @@ type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall struct { // SearchForSeries: SearchForSeries returns a list of matching series. See // RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of SearchForSeries, see Search transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -14688,7 +14688,7 @@ type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall struct { // SearchForStudies: SearchForStudies returns a list of matching studies. See // RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of SearchForStudies, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -15001,7 +15001,7 @@ type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall struct { // StoreInstances: StoreInstances stores DICOM instances associated with study // instance unique identifiers (SUID). See Store Transaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). // For details on the implementation of StoreInstances, see Store transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -15831,7 +15831,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall struct { // RetrieveMetadata: RetrieveStudyMetadata returns instance associated with the // given study presented as metadata. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveStudyMetadata, see Metadata // resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the @@ -15922,7 +15922,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall struct { // RetrieveStudy: RetrieveStudy returns all instances within the given study. // See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveStudy, see DICOM // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) @@ -16013,7 +16013,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall struct { // SearchForInstances: SearchForInstances returns a list of matching instances. // See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of SearchForInstances, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -16105,7 +16105,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall struct { // SearchForSeries: SearchForSeries returns a list of matching series. See // RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of SearchForSeries, see Search transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -16195,7 +16195,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall struct { // StoreInstances: StoreInstances stores DICOM instances associated with study // instance unique identifiers (SUID). See Store Transaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). // For details on the implementation of StoreInstances, see Store transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the // Cloud Healthcare API conformance statement. For samples that show how to @@ -16544,7 +16544,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall struc // RetrieveMetadata: RetrieveSeriesMetadata returns instance associated with // the given study and series, presented as metadata. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveSeriesMetadata, see Metadata // resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the @@ -16635,7 +16635,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall struct // RetrieveSeries: RetrieveSeries returns all instances within the given study // and series. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveSeries, see DICOM // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) @@ -16726,7 +16726,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall str // SearchForInstances: SearchForInstances returns a list of matching instances. // See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of SearchForInstances, see Search // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the @@ -17007,7 +17007,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceC // RetrieveInstance: RetrieveInstance returns instance associated with the // given study, series, and SOP Instance UID. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveInstance, see DICOM // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) @@ -17102,7 +17102,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataC // RetrieveMetadata: RetrieveInstanceMetadata returns instance associated with // the given study, series, and SOP Instance UID presented as metadata. See // RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveInstanceMetadata, see Metadata // resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the @@ -17196,7 +17196,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedC // RetrieveRendered: RetrieveRenderedInstance returns instance associated with // the given study, series, and SOP Instance UID in an acceptable Rendered // Media Type. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveRenderedInstance, see Rendered // resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the @@ -17375,7 +17375,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesBulkdataRetrieveB // RetrieveBulkdata: Returns uncompressed, unencoded bytes representing the // referenced bulkdata tag from an instance. See Retrieve Transaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveBulkdata, see Bulkdata // resources // (https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the @@ -17468,7 +17468,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFra // RetrieveFrames: RetrieveFrames returns instances associated with the given // study, series, SOP Instance UID and frame numbers. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveFrames, see DICOM frames // (https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud // Healthcare API conformance statement. For samples that show how to call @@ -17561,7 +17561,7 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRen // RetrieveRendered: RetrieveRenderedFrames returns instances associated with // the given study, series, SOP Instance UID and frame numbers in an acceptable // Rendered Media Type. See RetrieveTransaction -// (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). +// (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). // For details on the implementation of RetrieveRenderedFrames, see Rendered // resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json index ad3130fc692..e1b6e509f8b 100644 --- a/iam/v1/iam-api.json +++ b/iam/v1/iam-api.json @@ -864,7 +864,7 @@ "scimTenants": { "methods": { "create": { - "description": "Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant until 30 days after deletion.", + "description": "Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.create", @@ -873,14 +873,14 @@ ], "parameters": { "parent": { - "description": "Required. The parent to create scim tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", + "description": "Required. Agentspace only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$", "required": true, "type": "string" }, "workforcePoolProviderScimTenantId": { - "description": "Required. The ID to use for the scim tenant, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].", + "description": "Required. Agentspace only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters [a-z0-9-].", "location": "query", "type": "string" } @@ -897,7 +897,7 @@ ] }, "delete": { - "description": "Deletes a WorkforcePoolProviderScimTenant. You can undelete a scim tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tenants. However, you can view and list them.", + "description": "Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "DELETE", "id": "iam.locations.workforcePools.providers.scimTenants.delete", @@ -906,7 +906,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", + "description": "Required. Agentspace only. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -922,7 +922,7 @@ ] }, "get": { - "description": "Gets an individual WorkforcePoolProviderScimTenant.", + "description": "Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.get", @@ -931,7 +931,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the scim tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", + "description": "Required. Agentspace only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -947,7 +947,7 @@ ] }, "list": { - "description": "Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted scim tenants are also listed.", + "description": "Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.list", @@ -956,25 +956,25 @@ ], "parameters": { "pageSize": { - "description": "Optional. The maximum number of scim tenants to return. If unspecified, at most 1 scim tenant will be returned.", + "description": "Optional. Agentspace only. The maximum number of SCIM tenants to return. If unspecified, at most 1 scim tenant will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.", + "description": "Optional. Agentspace only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent to list scim tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", + "description": "Required. Agentspace only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$", "required": true, "type": "string" }, "showDeleted": { - "description": "Optional. Whether to return soft-deleted scim tenants.", + "description": "Optional. Agentspace only. Whether to return soft-deleted SCIM tenants.", "location": "query", "type": "boolean" } @@ -988,7 +988,7 @@ ] }, "patch": { - "description": "Updates an existing WorkforcePoolProviderScimTenant.", + "description": "Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "PATCH", "id": "iam.locations.workforcePools.providers.scimTenants.patch", @@ -997,14 +997,14 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", + "description": "Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to update.", + "description": "Optional. Agentspace only. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1022,7 +1022,7 @@ ] }, "undelete": { - "description": "Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.", + "description": "Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:undelete", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.undelete", @@ -1031,7 +1031,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the scim tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", + "description": "Required. Agentspace only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -1054,7 +1054,7 @@ "tokens": { "methods": { "create": { - "description": "Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.", + "description": "Agentspace only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.create", @@ -1063,14 +1063,14 @@ ], "parameters": { "parent": { - "description": "Required. The parent tenant to create scim token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", + "description": "Required. Agentspace only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "workforcePoolProviderScimTokenId": { - "description": "Required. The ID to use for the scim token, which becomes the final component of the resource name. This value should be 4-32 characters and follow this pattern: \"([a-z]([a-z0-9\\\\-]{2,30}[a-z0-9]))\"", + "description": "Required. Agentspace only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: \"([a-z]([a-z0-9\\\\-]{2,30}[a-z0-9]))\"", "location": "query", "type": "string" } @@ -1087,7 +1087,7 @@ ] }, "delete": { - "description": "Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.", + "description": "Agentspace only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "DELETE", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.delete", @@ -1096,7 +1096,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the scim token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", + "description": "Required. Agentspace only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -1112,7 +1112,7 @@ ] }, "get": { - "description": "Gets an individual WorkforcePoolProviderScimToken.", + "description": "Agentspace only. Gets an individual WorkforcePoolProviderScimToken.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.get", @@ -1121,7 +1121,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the scim token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", + "description": "Required. Agentspace only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -1137,7 +1137,7 @@ ] }, "list": { - "description": "Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.", + "description": "Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.list", @@ -1146,25 +1146,25 @@ ], "parameters": { "pageSize": { - "description": "Optional. The maximum number of scim tokens to return. If unspecified, at most 2 scim tokens will be returned.", + "description": "Optional. Agentspace only. The maximum number of scim tokens to return. If unspecified, at most 2 SCIM tokens will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.", + "description": "Optional. Agentspace only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent to list scim tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", + "description": "Required. Agentspace only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "showDeleted": { - "description": "Optional. Whether to return soft-deleted scim tokens.", + "description": "Optional. Agentspace only. Whether to return soft-deleted scim tokens.", "location": "query", "type": "boolean" } @@ -1178,7 +1178,7 @@ ] }, "patch": { - "description": "Updates an existing WorkforcePoolProviderScimToken.", + "description": "Agentspace only. Updates an existing WorkforcePoolProviderScimToken.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "PATCH", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.patch", @@ -1187,14 +1187,14 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", + "description": "Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to update.", + "description": "Optional. Agentspace only. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1212,7 +1212,7 @@ ] }, "undelete": { - "description": "Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.", + "description": "Agentspace only. Undeletes a WorkforcePoolProviderScimToken,that was deleted fewer than 30 days ago.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}:undelete", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.undelete", @@ -1221,7 +1221,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the scim token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", + "description": "Required. Agentspace only. The name of the SCIM token to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -2578,7 +2578,7 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the managed identity.", + "description": "Output only. The resource name of the managed identity.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$", "required": true, @@ -2948,7 +2948,7 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the provider.", + "description": "Output only. The resource name of the provider.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+$", "required": true, @@ -4155,7 +4155,7 @@ } } }, - "revision": "20250919", + "revision": "20250925", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -5013,15 +5013,15 @@ "type": "object" }, "ListWorkforcePoolProviderScimTenantsResponse": { - "description": "Response message for ListWorkforcePoolProviderScimTenants.", + "description": "Agentspace only. Response message for ListWorkforcePoolProviderScimTenants.", "id": "ListWorkforcePoolProviderScimTenantsResponse", "properties": { "nextPageToken": { - "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "workforcePoolProviderScimTenants": { - "description": "Output only. A list of scim tenants.", + "description": "Output only. Agentspace only. A list of SCIM tenants.", "items": { "$ref": "WorkforcePoolProviderScimTenant" }, @@ -5032,15 +5032,15 @@ "type": "object" }, "ListWorkforcePoolProviderScimTokensResponse": { - "description": "Response message for ListWorkforcePoolProviderScimTokens.", + "description": "Agentspace only. Response message for ListWorkforcePoolProviderScimTokens.", "id": "ListWorkforcePoolProviderScimTokensResponse", "properties": { "nextPageToken": { - "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "workforcePoolProviderScimTokens": { - "description": "Output only. A list of scim tokens.", + "description": "Output only. Agentspace only. A list of SCIM tokens.", "items": { "$ref": "WorkforcePoolProviderScimToken" }, @@ -6168,13 +6168,13 @@ "type": "object" }, "UndeleteWorkforcePoolProviderScimTenantRequest": { - "description": "Request message for UndeleteWorkforcePoolProviderScimTenant.", + "description": "Agentspace only. Request message for UndeleteWorkforcePoolProviderScimTenant.", "id": "UndeleteWorkforcePoolProviderScimTenantRequest", "properties": {}, "type": "object" }, "UndeleteWorkforcePoolProviderScimTokenRequest": { - "description": "Request message for UndeleteWorkforcePoolProviderScimToken.", + "description": "Agentspace only. Request message for UndeleteWorkforcePoolProviderScimToken.", "id": "UndeleteWorkforcePoolProviderScimTokenRequest", "properties": {}, "type": "object" @@ -6302,7 +6302,7 @@ "additionalProperties": { "type": "string" }, - "description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex \"^a-zA-Z0-9._{0,31}$\". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", + "description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex \"^a-zA-Z0-9._{0,31}$\". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", "type": "object" }, "description": { @@ -6414,11 +6414,11 @@ "type": "object" }, "WorkforcePoolProviderScimTenant": { - "description": "Represents a scim tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.", + "description": "Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.", "id": "WorkforcePoolProviderScimTenant", "properties": { "baseUri": { - "description": "Output only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/", + "description": "Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/", "readOnly": true, "type": "string" }, @@ -6426,38 +6426,43 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Maps BYOID claims to SCIM claims.", + "description": "Optional. Agentspace only. Maps BYOID claims to SCIM claims.", "type": "object" }, "description": { - "description": "Optional. The description of the scim tenant. Cannot exceed 256 characters.", + "description": "Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.", "type": "string" }, "displayName": { - "description": "Optional. The display name of the scim tenant. Cannot exceed 32 characters.", + "description": "Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.", "type": "string" }, "name": { - "description": "Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", + "description": "Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", "type": "string" }, "purgeTime": { - "description": "Output only. The timestamp when the scim tenant is going to be purged.", + "description": "Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "serviceAgent": { + "description": "Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.", + "readOnly": true, + "type": "string" + }, "state": { - "description": "Output only. The state of the tenant.", + "description": "Output only. Agentspace only. The state of the tenant.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DELETED" ], "enumDescriptions": [ - "State unspecified.", - "The tenant is active and may be used to provision users and groups.", - "The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." + "Agentspace only. State unspecified.", + "Agentspace only. The tenant is active and may be used to provision users and groups.", + "Agentspace only. The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." ], "readOnly": true, "type": "string" @@ -6466,33 +6471,33 @@ "type": "object" }, "WorkforcePoolProviderScimToken": { - "description": "Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.", + "description": "Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.", "id": "WorkforcePoolProviderScimToken", "properties": { "displayName": { - "description": "Optional. The display name of the scim token. Cannot exceed 32 characters.", + "description": "Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.", "type": "string" }, "name": { - "description": "Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", + "description": "Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", "type": "string" }, "securityToken": { - "description": "Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.", + "description": "Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. The state of the token.", + "description": "Output only. Agentspace only. The state of the token.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DELETED" ], "enumDescriptions": [ - "State unspecified.", - "The tenant is active and may be used to provision users and groups.", - "The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." + "Agentspace only. State unspecified.", + "Agentspace only. The token is active and may be used to provision users and groups.", + "Agentspace only. The token is soft-deleted. Soft-deleted tokens are permanently deleted after approximately 30 days." ], "readOnly": true, "type": "string" @@ -6586,7 +6591,8 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the managed identity.", + "description": "Output only. The resource name of the managed identity.", + "readOnly": true, "type": "string" }, "state": { @@ -6697,7 +6703,8 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the provider.", + "description": "Output only. The resource name of the provider.", + "readOnly": true, "type": "string" }, "oidc": { diff --git a/iam/v1/iam-gen.go b/iam/v1/iam-gen.go index dab29bd374f..662ba3b993d 100644 --- a/iam/v1/iam-gen.go +++ b/iam/v1/iam-gen.go @@ -2000,14 +2000,15 @@ func (s ListWorkforcePoolProviderKeysResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// ListWorkforcePoolProviderScimTenantsResponse: Response message for -// ListWorkforcePoolProviderScimTenants. +// ListWorkforcePoolProviderScimTenantsResponse: Agentspace only. Response +// message for ListWorkforcePoolProviderScimTenants. type ListWorkforcePoolProviderScimTenantsResponse struct { - // NextPageToken: Optional. A token, which can be sent as `page_token` to - // retrieve the next page. If this field is omitted, there are no subsequent - // pages. + // NextPageToken: Optional. Agentspace only. A token, which can be sent as + // `page_token` to retrieve the next page. If this field is omitted, there are + // no subsequent pages. NextPageToken string `json:"nextPageToken,omitempty"` - // WorkforcePoolProviderScimTenants: Output only. A list of scim tenants. + // WorkforcePoolProviderScimTenants: Output only. Agentspace only. A list of + // SCIM tenants. WorkforcePoolProviderScimTenants []*WorkforcePoolProviderScimTenant `json:"workforcePoolProviderScimTenants,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -2030,14 +2031,15 @@ func (s ListWorkforcePoolProviderScimTenantsResponse) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// ListWorkforcePoolProviderScimTokensResponse: Response message for -// ListWorkforcePoolProviderScimTokens. +// ListWorkforcePoolProviderScimTokensResponse: Agentspace only. Response +// message for ListWorkforcePoolProviderScimTokens. type ListWorkforcePoolProviderScimTokensResponse struct { - // NextPageToken: Optional. A token, which can be sent as `page_token` to - // retrieve the next page. If this field is omitted, there are no subsequent - // pages. + // NextPageToken: Optional. Agentspace only. A token, which can be sent as + // `page_token` to retrieve the next page. If this field is omitted, there are + // no subsequent pages. NextPageToken string `json:"nextPageToken,omitempty"` - // WorkforcePoolProviderScimTokens: Output only. A list of scim tokens. + // WorkforcePoolProviderScimTokens: Output only. Agentspace only. A list of + // SCIM tokens. WorkforcePoolProviderScimTokens []*WorkforcePoolProviderScimToken `json:"workforcePoolProviderScimTokens,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -3654,13 +3656,13 @@ type UndeleteWorkforcePoolProviderKeyRequest struct { type UndeleteWorkforcePoolProviderRequest struct { } -// UndeleteWorkforcePoolProviderScimTenantRequest: Request message for -// UndeleteWorkforcePoolProviderScimTenant. +// UndeleteWorkforcePoolProviderScimTenantRequest: Agentspace only. Request +// message for UndeleteWorkforcePoolProviderScimTenant. type UndeleteWorkforcePoolProviderScimTenantRequest struct { } -// UndeleteWorkforcePoolProviderScimTokenRequest: Request message for -// UndeleteWorkforcePoolProviderScimToken. +// UndeleteWorkforcePoolProviderScimTokenRequest: Agentspace only. Request +// message for UndeleteWorkforcePoolProviderScimToken. type UndeleteWorkforcePoolProviderScimTokenRequest struct { } @@ -3849,7 +3851,7 @@ type WorkforcePoolProvider struct { // to access a JSON representation of the authentication credential issued by // the provider. The maximum length of an attribute mapping expression is 2048 // characters. When evaluated, the total size of all mapped attributes must not - // exceed 4KB. For OIDC providers, you must supply a custom mapping that + // exceed 16 KB. For OIDC providers, you must supply a custom mapping that // includes the `google.subject` attribute. For example, the following maps the // `sub` claim of the incoming credential to the `subject` attribute on a // Google token: ``` {"google.subject": "assertion.sub"} ``` @@ -3978,38 +3980,42 @@ func (s WorkforcePoolProviderKey) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// WorkforcePoolProviderScimTenant: Represents a scim tenant. Used for -// provisioning and managing identity data (such as Users and Groups) in -// cross-domain environments. +// WorkforcePoolProviderScimTenant: Agentspace only. Represents a SCIM tenant. +// Used for provisioning and managing identity data (such as Users and Groups) +// in cross-domain environments. type WorkforcePoolProviderScimTenant struct { - // BaseUri: Output only. Represents the base URI as defined in RFC 7644, - // Section 1.3 (https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). - // Clients must use this as the root address for managing resources under the - // tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + // BaseUri: Output only. Agentspace only. Represents the base URI as defined in + // RFC 7644, Section 1.3 + // (https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must + // use this as the root address for managing resources under the tenant. + // Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ BaseUri string `json:"baseUri,omitempty"` - // ClaimMapping: Optional. Maps BYOID claims to SCIM claims. + // ClaimMapping: Optional. Agentspace only. Maps BYOID claims to SCIM claims. ClaimMapping map[string]string `json:"claimMapping,omitempty"` - // Description: Optional. The description of the scim tenant. Cannot exceed 256 - // characters. + // Description: Optional. Agentspace only. The description of the SCIM tenant. + // Cannot exceed 256 characters. Description string `json:"description,omitempty"` - // DisplayName: Optional. The display name of the scim tenant. Cannot exceed 32 - // characters. + // DisplayName: Optional. Agentspace only. The display name of the SCIM tenant. + // Cannot exceed 32 characters. DisplayName string `json:"displayName,omitempty"` - // Name: Identifier. The resource name of the SCIM Tenant. Format: - // `locations/{location}/workforcePools/{workforce_pool}/providers/ + // Name: Identifier. Agentspace only. The resource name of the SCIM Tenant. + // Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ // {workforce_pool_provider}/scimTenants/{scim_tenant}` Name string `json:"name,omitempty"` - // PurgeTime: Output only. The timestamp when the scim tenant is going to be - // purged. + // PurgeTime: Output only. Agentspace only. The timestamp that represents the + // time when the SCIM tenant is purged. PurgeTime string `json:"purgeTime,omitempty"` - // State: Output only. The state of the tenant. + // ServiceAgent: Output only. Service Agent created by SCIM Tenant API. SCIM + // tokens created under this tenant will be attached to this service agent. + ServiceAgent string `json:"serviceAgent,omitempty"` + // State: Output only. Agentspace only. The state of the tenant. // // Possible values: - // "STATE_UNSPECIFIED" - State unspecified. - // "ACTIVE" - The tenant is active and may be used to provision users and - // groups. - // "DELETED" - The tenant is soft-deleted. Soft-deleted tenants are - // permanently deleted after approximately 30 days. + // "STATE_UNSPECIFIED" - Agentspace only. State unspecified. + // "ACTIVE" - Agentspace only. The tenant is active and may be used to + // provision users and groups. + // "DELETED" - Agentspace only. The tenant is soft-deleted. Soft-deleted + // tenants are permanently deleted after approximately 30 days. State string `json:"state,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -4032,28 +4038,28 @@ func (s WorkforcePoolProviderScimTenant) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// WorkforcePoolProviderScimToken: Represents a token for the -// WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning +// WorkforcePoolProviderScimToken: Agentspace only. Represents a token for the +// WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning // requests. type WorkforcePoolProviderScimToken struct { - // DisplayName: Optional. The display name of the scim token. Cannot exceed 32 - // characters. + // DisplayName: Optional. Agentspace only. The display name of the SCIM token. + // Cannot exceed 32 characters. DisplayName string `json:"displayName,omitempty"` - // Name: Identifier. The resource name of the SCIM Token. Format: - // `locations/{location}/workforcePools/{workforce_pool}/providers/ + // Name: Identifier. Agentspace only. The resource name of the SCIM Token. + // Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ // {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` Name string `json:"name,omitempty"` - // SecurityToken: Output only. The token string. Provide this to the IdP for - // authentication. Will be set only during creation. + // SecurityToken: Output only. Agentspace only. The token string. Provide this + // to the IdP for authentication. Will be set only during creation. SecurityToken string `json:"securityToken,omitempty"` - // State: Output only. The state of the token. + // State: Output only. Agentspace only. The state of the token. // // Possible values: - // "STATE_UNSPECIFIED" - State unspecified. - // "ACTIVE" - The tenant is active and may be used to provision users and - // groups. - // "DELETED" - The tenant is soft-deleted. Soft-deleted tenants are - // permanently deleted after approximately 30 days. + // "STATE_UNSPECIFIED" - Agentspace only. State unspecified. + // "ACTIVE" - Agentspace only. The token is active and may be used to + // provision users and groups. + // "DELETED" - Agentspace only. The token is soft-deleted. Soft-deleted + // tokens are permanently deleted after approximately 30 days. State string `json:"state,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -4166,7 +4172,7 @@ type WorkloadIdentityPoolManagedIdentity struct { // ExpireTime: Output only. Time after which the managed identity will be // permanently purged and cannot be recovered. ExpireTime string `json:"expireTime,omitempty"` - // Name: Identifier. The resource name of the managed identity. + // Name: Output only. The resource name of the managed identity. Name string `json:"name,omitempty"` // State: Output only. The state of the managed identity. // @@ -4329,7 +4335,7 @@ type WorkloadIdentityPoolProvider struct { // ExpireTime: Output only. Time after which the workload identity pool // provider will be permanently purged and cannot be recovered. ExpireTime string `json:"expireTime,omitempty"` - // Name: Identifier. The resource name of the provider. + // Name: Output only. The resource name of the provider. Name string `json:"name,omitempty"` // Oidc: An OpenId Connect 1.0 identity provider. Oidc *Oidc `json:"oidc,omitempty"` @@ -7301,11 +7307,11 @@ type LocationsWorkforcePoolsProvidersScimTenantsCreateCall struct { header_ http.Header } -// Create: Creates a new WorkforcePoolProviderScimTenant in a -// WorkforcePoolProvider. You cannot reuse the name of a deleted scim tenant +// Create: Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a +// WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant // until 30 days after deletion. // -// - parent: The parent to create scim tenant. Format: +// - parent: Agentspace only. The parent to create SCIM tenant. Format: // 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'. func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Create(parent string, workforcepoolproviderscimtenant *WorkforcePoolProviderScimTenant) *LocationsWorkforcePoolsProvidersScimTenantsCreateCall { c := &LocationsWorkforcePoolsProvidersScimTenantsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7315,9 +7321,10 @@ func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Create(parent strin } // WorkforcePoolProviderScimTenantId sets the optional parameter -// "workforcePoolProviderScimTenantId": Required. The ID to use for the scim -// tenant, which becomes the final component of the resource name. This value -// should be 4-32 characters, and may contain the characters [a-z0-9-]. +// "workforcePoolProviderScimTenantId": Required. Agentspace only. The ID to +// use for the SCIM tenant, which becomes the final component of the resource +// name. This value should be 4-32 characters, containing the characters +// [a-z0-9-]. func (c *LocationsWorkforcePoolsProvidersScimTenantsCreateCall) WorkforcePoolProviderScimTenantId(workforcePoolProviderScimTenantId string) *LocationsWorkforcePoolsProvidersScimTenantsCreateCall { c.urlParams_.Set("workforcePoolProviderScimTenantId", workforcePoolProviderScimTenantId) return c @@ -7416,11 +7423,11 @@ type LocationsWorkforcePoolsProvidersScimTenantsDeleteCall struct { header_ http.Header } -// Delete: Deletes a WorkforcePoolProviderScimTenant. You can undelete a scim -// tenant for 30 days. After 30 days, deletion is permanent. You cannot update -// deleted scim tenants. However, you can view and list them. +// Delete: Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can +// undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. +// You cannot update deleted SCIM tenants. However, you can view and list them. // -// - name: The name of the scim tenant to delete. Format: +// - name: Agentspace only. The name of the scim tenant to delete. Format: // `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Delete(name string) *LocationsWorkforcePoolsProvidersScimTenantsDeleteCall { @@ -7519,9 +7526,9 @@ type LocationsWorkforcePoolsProvidersScimTenantsGetCall struct { header_ http.Header } -// Get: Gets an individual WorkforcePoolProviderScimTenant. +// Get: Agentspace only. Gets an individual WorkforcePoolProviderScimTenant. // -// - name: The name of the scim tenant to retrieve. Format: +// - name: Agentspace only. The name of the SCIM tenant to retrieve. Format: // `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Get(name string) *LocationsWorkforcePoolsProvidersScimTenantsGetCall { @@ -7631,11 +7638,11 @@ type LocationsWorkforcePoolsProvidersScimTenantsListCall struct { header_ http.Header } -// List: Lists all non-deleted WorkforcePoolProviderScimTenants in a -// WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted scim -// tenants are also listed. +// List: Agentspace only. Lists all non-deleted +// WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If +// `show_deleted` is set to `true`, then deleted SCIM tenants are also listed. // -// - parent: The parent to list scim tenants. Format: +// - parent: Agentspace only. The parent to list SCIM tenants. Format: // 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'. func (r *LocationsWorkforcePoolsProvidersScimTenantsService) List(parent string) *LocationsWorkforcePoolsProvidersScimTenantsListCall { c := &LocationsWorkforcePoolsProvidersScimTenantsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7643,23 +7650,24 @@ func (r *LocationsWorkforcePoolsProvidersScimTenantsService) List(parent string) return c } -// PageSize sets the optional parameter "pageSize": The maximum number of scim -// tenants to return. If unspecified, at most 1 scim tenant will be returned. +// PageSize sets the optional parameter "pageSize": Agentspace only. The +// maximum number of SCIM tenants to return. If unspecified, at most 1 scim +// tenant will be returned. func (c *LocationsWorkforcePoolsProvidersScimTenantsListCall) PageSize(pageSize int64) *LocationsWorkforcePoolsProvidersScimTenantsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c } -// PageToken sets the optional parameter "pageToken": A page token, received -// from a previous `ListScimTenants` call. Provide this to retrieve the -// subsequent page. +// PageToken sets the optional parameter "pageToken": Agentspace only. A page +// token, received from a previous `ListScimTenants` call. Provide this to +// retrieve the subsequent page. func (c *LocationsWorkforcePoolsProvidersScimTenantsListCall) PageToken(pageToken string) *LocationsWorkforcePoolsProvidersScimTenantsListCall { c.urlParams_.Set("pageToken", pageToken) return c } -// ShowDeleted sets the optional parameter "showDeleted": Whether to return -// soft-deleted scim tenants. +// ShowDeleted sets the optional parameter "showDeleted": Agentspace only. +// Whether to return soft-deleted SCIM tenants. func (c *LocationsWorkforcePoolsProvidersScimTenantsListCall) ShowDeleted(showDeleted bool) *LocationsWorkforcePoolsProvidersScimTenantsListCall { c.urlParams_.Set("showDeleted", fmt.Sprint(showDeleted)) return c @@ -7787,10 +7795,10 @@ type LocationsWorkforcePoolsProvidersScimTenantsPatchCall struct { header_ http.Header } -// Patch: Updates an existing WorkforcePoolProviderScimTenant. +// Patch: Agentspace only. Updates an existing WorkforcePoolProviderScimTenant. // -// - name: Identifier. The resource name of the SCIM Tenant. Format: -// `locations/{location}/workforcePools/{workforce_pool}/providers/ +// - name: Identifier. Agentspace only. The resource name of the SCIM Tenant. +// Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ // {workforce_pool_provider}/scimTenants/{scim_tenant}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Patch(name string, workforcepoolproviderscimtenant *WorkforcePoolProviderScimTenant) *LocationsWorkforcePoolsProvidersScimTenantsPatchCall { c := &LocationsWorkforcePoolsProvidersScimTenantsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7799,8 +7807,8 @@ func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Patch(name string, return c } -// UpdateMask sets the optional parameter "updateMask": The list of fields to -// update. +// UpdateMask sets the optional parameter "updateMask": Agentspace only. The +// list of fields to update. func (c *LocationsWorkforcePoolsProvidersScimTenantsPatchCall) UpdateMask(updateMask string) *LocationsWorkforcePoolsProvidersScimTenantsPatchCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -7900,10 +7908,10 @@ type LocationsWorkforcePoolsProvidersScimTenantsUndeleteCall struct { header_ http.Header } -// Undelete: Undeletes a WorkforcePoolProviderScimTenant, as long as it was -// deleted fewer than 30 days ago. +// Undelete: Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that +// was deleted fewer than 30 days ago. // -// - name: The name of the scim tenant to undelete. Format: +// - name: Agentspace only. The name of the SCIM tenant to undelete. Format: // `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsService) Undelete(name string, undeleteworkforcepoolproviderscimtenantrequest *UndeleteWorkforcePoolProviderScimTenantRequest) *LocationsWorkforcePoolsProvidersScimTenantsUndeleteCall { @@ -8007,11 +8015,11 @@ type LocationsWorkforcePoolsProvidersScimTenantsTokensCreateCall struct { header_ http.Header } -// Create: Creates a new WorkforcePoolProviderScimToken in a +// Create: Agentspace only. Creates a new WorkforcePoolProviderScimToken in a // WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM // token until 30 days after deletion. // -// - parent: The parent tenant to create scim token. Format: +// - parent: Agentspace only. The parent tenant to create SCIM token. Format: // 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}'. func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Create(parent string, workforcepoolproviderscimtoken *WorkforcePoolProviderScimToken) *LocationsWorkforcePoolsProvidersScimTenantsTokensCreateCall { @@ -8022,9 +8030,9 @@ func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Create(parent } // WorkforcePoolProviderScimTokenId sets the optional parameter -// "workforcePoolProviderScimTokenId": Required. The ID to use for the scim -// token, which becomes the final component of the resource name. This value -// should be 4-32 characters and follow this pattern: "(a-z +// "workforcePoolProviderScimTokenId": Required. Agentspace only. The ID to use +// for the SCIM token, which becomes the final component of the resource name. +// This value should be 4-32 characters and follow the pattern: "(a-z // ([a-z0-9\\-]{2,30}[a-z0-9]))" func (c *LocationsWorkforcePoolsProvidersScimTenantsTokensCreateCall) WorkforcePoolProviderScimTokenId(workforcePoolProviderScimTokenId string) *LocationsWorkforcePoolsProvidersScimTenantsTokensCreateCall { c.urlParams_.Set("workforcePoolProviderScimTokenId", workforcePoolProviderScimTokenId) @@ -8124,11 +8132,12 @@ type LocationsWorkforcePoolsProvidersScimTenantsTokensDeleteCall struct { header_ http.Header } -// Delete: Deletes a WorkforcePoolProviderScimToken. You can undelete a scim -// token for 30 days. After 30 days, deletion is permanent. You cannot update -// deleted scim tokens. However, you can view and list them. +// Delete: Agentspace only. Deletes a WorkforcePoolProviderScimToken. You can +// undelete a SCIM token for 30 days. After 30 days, the SCIM token is +// permanently deleted. You cannot update deleted SCIM tokens, however, you can +// view and list them. // -// - name: The name of the scim token to delete. Format: +// - name: Agentspace only. The name of the SCIM token to delete. Format: // `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}/tokens/{token}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Delete(name string) *LocationsWorkforcePoolsProvidersScimTenantsTokensDeleteCall { @@ -8227,9 +8236,9 @@ type LocationsWorkforcePoolsProvidersScimTenantsTokensGetCall struct { header_ http.Header } -// Get: Gets an individual WorkforcePoolProviderScimToken. +// Get: Agentspace only. Gets an individual WorkforcePoolProviderScimToken. // -// - name: The name of the scim token to retrieve. Format: +// - name: Agentspace only. The name of the SCIM token to retrieve. Format: // `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}/tokens/{token}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Get(name string) *LocationsWorkforcePoolsProvidersScimTenantsTokensGetCall { @@ -8339,11 +8348,11 @@ type LocationsWorkforcePoolsProvidersScimTenantsTokensListCall struct { header_ http.Header } -// List: Lists all non-deleted WorkforcePoolProviderScimTokenss in a -// WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then -// deleted SCIM tokens are also listed. +// List: Agentspace only. Lists all non-deleted +// WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If +// `show_deleted` is set to `true`, then deleted SCIM tokens are also listed. // -// - parent: The parent to list scim tokens. Format: +// - parent: Agentspace only. The parent to list SCIM tokens. Format: // 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}'. func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) List(parent string) *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall { @@ -8352,23 +8361,24 @@ func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) List(parent s return c } -// PageSize sets the optional parameter "pageSize": The maximum number of scim -// tokens to return. If unspecified, at most 2 scim tokens will be returned. +// PageSize sets the optional parameter "pageSize": Agentspace only. The +// maximum number of scim tokens to return. If unspecified, at most 2 SCIM +// tokens will be returned. func (c *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall) PageSize(pageSize int64) *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c } -// PageToken sets the optional parameter "pageToken": A page token, received -// from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to -// retrieve the subsequent page. +// PageToken sets the optional parameter "pageToken": Agentspace only. A page +// token, received from a previous `ListWorkforcePoolProviderScimTokens` call. +// Provide this to retrieve the subsequent page. func (c *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall) PageToken(pageToken string) *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall { c.urlParams_.Set("pageToken", pageToken) return c } -// ShowDeleted sets the optional parameter "showDeleted": Whether to return -// soft-deleted scim tokens. +// ShowDeleted sets the optional parameter "showDeleted": Agentspace only. +// Whether to return soft-deleted scim tokens. func (c *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall) ShowDeleted(showDeleted bool) *LocationsWorkforcePoolsProvidersScimTenantsTokensListCall { c.urlParams_.Set("showDeleted", fmt.Sprint(showDeleted)) return c @@ -8496,10 +8506,10 @@ type LocationsWorkforcePoolsProvidersScimTenantsTokensPatchCall struct { header_ http.Header } -// Patch: Updates an existing WorkforcePoolProviderScimToken. +// Patch: Agentspace only. Updates an existing WorkforcePoolProviderScimToken. // -// - name: Identifier. The resource name of the SCIM Token. Format: -// `locations/{location}/workforcePools/{workforce_pool}/providers/ +// - name: Identifier. Agentspace only. The resource name of the SCIM Token. +// Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ // {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Patch(name string, workforcepoolproviderscimtoken *WorkforcePoolProviderScimToken) *LocationsWorkforcePoolsProvidersScimTenantsTokensPatchCall { c := &LocationsWorkforcePoolsProvidersScimTenantsTokensPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -8508,8 +8518,8 @@ func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Patch(name st return c } -// UpdateMask sets the optional parameter "updateMask": The list of fields to -// update. +// UpdateMask sets the optional parameter "updateMask": Agentspace only. The +// list of fields to update. func (c *LocationsWorkforcePoolsProvidersScimTenantsTokensPatchCall) UpdateMask(updateMask string) *LocationsWorkforcePoolsProvidersScimTenantsTokensPatchCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -8609,10 +8619,10 @@ type LocationsWorkforcePoolsProvidersScimTenantsTokensUndeleteCall struct { header_ http.Header } -// Undelete: Undeletes a WorkforcePoolProviderScimToken, as long as it was -// deleted fewer than 30 days ago. +// Undelete: Agentspace only. Undeletes a WorkforcePoolProviderScimToken,that +// was deleted fewer than 30 days ago. // -// - name: The name of the scim token to undelete. Format: +// - name: Agentspace only. The name of the SCIM token to undelete. Format: // `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/ // scimTenants/{scim_tenant}/tokens/{token}`. func (r *LocationsWorkforcePoolsProvidersScimTenantsTokensService) Undelete(name string, undeleteworkforcepoolproviderscimtokenrequest *UndeleteWorkforcePoolProviderScimTokenRequest) *LocationsWorkforcePoolsProvidersScimTenantsTokensUndeleteCall { @@ -13728,7 +13738,7 @@ type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesPatchCall // Patch: Updates an existing WorkloadIdentityPoolManagedIdentity in a // WorkloadIdentityPoolNamespace. // -// - name: Identifier. The resource name of the managed identity. +// - name: Output only. The resource name of the managed identity. func (r *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService) Patch(name string, workloadidentitypoolmanagedidentity *WorkloadIdentityPoolManagedIdentity) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesPatchCall { c := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -15079,7 +15089,7 @@ type ProjectsLocationsWorkloadIdentityPoolsProvidersPatchCall struct { // Patch: Updates an existing WorkloadIdentityPoolProvider. // -// - name: Identifier. The resource name of the provider. +// - name: Output only. The resource name of the provider. func (r *ProjectsLocationsWorkloadIdentityPoolsProvidersService) Patch(name string, workloadidentitypoolprovider *WorkloadIdentityPoolProvider) *ProjectsLocationsWorkloadIdentityPoolsProvidersPatchCall { c := &ProjectsLocationsWorkloadIdentityPoolsProvidersPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name diff --git a/privateca/v1/privateca-api.json b/privateca/v1/privateca-api.json index 0a602764962..4f6f5be9b1a 100644 --- a/privateca/v1/privateca-api.json +++ b/privateca/v1/privateca-api.json @@ -1594,6 +1594,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1611,7 +1616,7 @@ } } }, - "revision": "20250910", + "revision": "20250926", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -2854,6 +2859,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/privateca/v1/privateca-gen.go b/privateca/v1/privateca-gen.go index 3c97e58225d..72f74f68697 100644 --- a/privateca/v1/privateca-gen.go +++ b/privateca/v1/privateca-gen.go @@ -1961,6 +1961,11 @@ type ListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -8349,6 +8354,19 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/privateca/v1beta1/privateca-api.json b/privateca/v1beta1/privateca-api.json index d265ffdc86b..9e08caf3a81 100644 --- a/privateca/v1beta1/privateca-api.json +++ b/privateca/v1beta1/privateca-api.json @@ -478,6 +478,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -586,7 +591,7 @@ } } }, - "revision": "20250910", + "revision": "20250926", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { @@ -726,6 +731,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/privateca/v1beta1/privateca-gen.go b/privateca/v1beta1/privateca-gen.go index 638017671c3..1aa32995273 100644 --- a/privateca/v1beta1/privateca-gen.go +++ b/privateca/v1beta1/privateca-gen.go @@ -494,6 +494,11 @@ type ListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -2134,6 +2139,19 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/recaptchaenterprise/v1/recaptchaenterprise-api.json b/recaptchaenterprise/v1/recaptchaenterprise-api.json index e5f5d49d255..82324655eb9 100644 --- a/recaptchaenterprise/v1/recaptchaenterprise-api.json +++ b/recaptchaenterprise/v1/recaptchaenterprise-api.json @@ -786,7 +786,7 @@ } } }, - "revision": "20250917", + "revision": "20250928", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1942,7 +1942,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1RiskAnalysis", "properties": { "challenge": { - "description": "Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys", + "description": "Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.", "enum": [ "CHALLENGE_UNSPECIFIED", "NOCAPTCHA", diff --git a/recaptchaenterprise/v1/recaptchaenterprise-gen.go b/recaptchaenterprise/v1/recaptchaenterprise-gen.go index 7c2bb52b96e..fd2a61f3d20 100644 --- a/recaptchaenterprise/v1/recaptchaenterprise-gen.go +++ b/recaptchaenterprise/v1/recaptchaenterprise-gen.go @@ -1877,7 +1877,7 @@ func (s GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse) Marshal // event. type GoogleCloudRecaptchaenterpriseV1RiskAnalysis struct { // Challenge: Output only. Challenge information for POLICY_BASED_CHALLENGE and - // INVISIBLE keys + // INVISIBLE keys. // // Possible values: // "CHALLENGE_UNSPECIFIED" - Default unspecified type. diff --git a/servicenetworking/v1/servicenetworking-api.json b/servicenetworking/v1/servicenetworking-api.json index 5dde5356615..e1462aca9e3 100644 --- a/servicenetworking/v1/servicenetworking-api.json +++ b/servicenetworking/v1/servicenetworking-api.json @@ -222,6 +222,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -1029,7 +1034,7 @@ } } }, - "revision": "20250722", + "revision": "20250929", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2767,6 +2772,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/servicenetworking/v1/servicenetworking-gen.go b/servicenetworking/v1/servicenetworking-gen.go index 3fbd51f5c7d..28e25f362cf 100644 --- a/servicenetworking/v1/servicenetworking-gen.go +++ b/servicenetworking/v1/servicenetworking-gen.go @@ -2841,6 +2841,11 @@ type ListOperationsResponse struct { // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,omitempty"` + // Unreachable: Unordered list. Unreachable resources. Populated when the + // request sets `ListOperationsRequest.return_partial_success` and reads across + // collections e.g. when attempting to list all resources across all supported + // locations. + Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -5504,6 +5509,19 @@ func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall { return c } +// ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": +// When set to `true`, operations that are reachable are returned as normal, +// and those that are unreachable are returned in the +// [ListOperationsResponse.unreachable] field. This can only be `true` when +// reading across collections e.g. when `parent` is set to +// "projects/example/locations/-". This field is not by default supported and +// will result in an `UNIMPLEMENTED` error if set unless explicitly documented +// otherwise in service or product specific documentation. +func (c *OperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *OperationsListCall { + c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json index b85a2d3bd79..34ae42465ec 100644 --- a/spanner/v1/spanner-api.json +++ b/spanner/v1/spanner-api.json @@ -1039,7 +1039,7 @@ "type": "string" }, "encryptionConfig.kmsKeyName": { - "description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", + "description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "location": "query", "type": "string" }, @@ -1050,7 +1050,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`.", + "description": "Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the form `projects//instances/`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+$", "required": true, @@ -1209,7 +1209,7 @@ "type": "string" }, "updateMask": { - "description": "Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.", + "description": "Required. A mask specifying which fields (for example, `expire_time`) in the backup resource should be updated. This mask is relative to the backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1868,7 +1868,7 @@ ] }, "updateDdl": { - "description": "Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.", + "description": "Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl", "httpMethod": "PATCH", "id": "spanner.projects.instances.databases.updateDdl", @@ -3406,7 +3406,7 @@ } } }, - "revision": "20250708", + "revision": "20250920", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AdaptMessageRequest": { @@ -3436,6 +3436,10 @@ "description": "Message sent by the adapter to the client.", "id": "AdaptMessageResponse", "properties": { + "last": { + "description": "Optional. Indicates whether this is the last AdaptMessageResponse in the stream. This field may be optionally set by the server. Clients should not rely on this field being set in all cases.", + "type": "boolean" + }, "payload": { "description": "Optional. Uninterpreted bytes from the underlying wire protocol.", "format": "byte", @@ -3656,7 +3660,7 @@ "type": "string" }, "instancePartitions": { - "description": "Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's `version_time`.", + "description": "Output only. The instance partition storing the backup. This is the same as the list of the instance partitions that the database recorded at the backup's `version_time`.", "items": { "$ref": "BackupInstancePartition" }, @@ -4093,6 +4097,11 @@ "precommitToken": { "$ref": "MultiplexedSessionPrecommitToken", "description": "If specified, transaction has not committed yet. You must retry the commit with the new precommit token." + }, + "snapshotTimestamp": { + "description": "If `TransactionOptions.isolation_level` is set to `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the timestamp at which all reads in the transaction ran. This timestamp is never returned.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -4163,12 +4172,12 @@ "Unspecified. Do not use.", "This is the default option for CopyBackup when encryption_config is not specified. For example, if the source backup is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the source backup.", "Use Google default encryption.", - "Use customer managed encryption. If specified, either `kms_key_name` or `kms_key_names` must contain valid Cloud KMS key(s)." + "Use customer managed encryption. If specified, either `kms_key_name` or `kms_key_names` must contain valid Cloud KMS keys." ], "type": "string" }, "kmsKeyName": { - "description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", + "description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -4250,7 +4259,7 @@ "type": "string" }, "kmsKeyName": { - "description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", + "description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -4729,18 +4738,18 @@ "id": "DdlStatementActionInfo", "properties": { "action": { - "description": "The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.", + "description": "The action for the DDL statement, for example, CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.", "type": "string" }, "entityNames": { - "description": "The entity name(s) being operated on the DDL statement. E.g. 1. For statement \"CREATE TABLE t1(...)\", `entity_names` = [\"t1\"]. 2. For statement \"GRANT ROLE r1, r2 ...\", `entity_names` = [\"r1\", \"r2\"]. 3. For statement \"ANALYZE\", `entity_names` = [].", + "description": "The entity names being operated on the DDL statement. For example, 1. For statement \"CREATE TABLE t1(...)\", `entity_names` = [\"t1\"]. 2. For statement \"GRANT ROLE r1, r2 ...\", `entity_names` = [\"r1\", \"r2\"]. 3. For statement \"ANALYZE\", `entity_names` = [].", "items": { "type": "string" }, "type": "array" }, "entityType": { - "description": "The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement \"ANALYZE\", `entity_type` = \"\".", + "description": "The entity type for the DDL statement, for example, TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, for example, for statement \"ANALYZE\", `entity_type` = \"\".", "type": "string" } }, @@ -5511,7 +5520,7 @@ "id": "InstanceEncryptionConfig", "properties": { "kmsKeyName": { - "description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. `kms_key_name` should only be used if the location of the KMS key matches the database instance’s configuration (location) exactly. E.g. The KMS location is in us-central1 or nam3 and the database instance is also in us-central1 or nam3. The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", + "description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -5628,7 +5637,7 @@ "id": "InstanceReplicaSelection", "properties": { "location": { - "description": "Required. Name of the location of the replicas (e.g., \"us-central1\").", + "description": "Required. Name of the location of the replicas (for example, \"us-central1\").", "type": "string" } }, @@ -7113,7 +7122,7 @@ "type": "string" }, "kmsKeyName": { - "description": "Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", + "description": "Optional. This field is maintained for backwards compatibility. For new callers, we recommend using `kms_key_names` to specify the KMS key. Only use `kms_key_name` if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in `us-central1` or `nam3`, then the database instance must also be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and decrypt the restored database. Set this field only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", "type": "string" }, "kmsKeyNames": { @@ -7426,7 +7435,7 @@ "id": "SingleRegionQuorum", "properties": { "servingLocation": { - "description": "Required. The location of the serving region, e.g. \"us-central1\". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type.", + "description": "Required. The location of the serving region, for example, \"us-central1\". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type.", "type": "string" } }, @@ -7745,7 +7754,7 @@ "type": "array" }, "throttled": { - "description": "Output only. When true, indicates that the operation is throttled e.g. due to resource constraints. When resources become available the operation will resume and this field will be false again.", + "description": "Output only. When true, indicates that the operation is throttled, for example, due to resource constraints. When resources become available the operation will resume and this field will be false again.", "readOnly": true, "type": "boolean" } @@ -7753,7 +7762,7 @@ "type": "object" }, "UpdateDatabaseDdlRequest": { - "description": "Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.", + "description": "Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (for example, if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.", "id": "UpdateDatabaseDdlRequest", "properties": { "operationId": { diff --git a/spanner/v1/spanner-gen.go b/spanner/v1/spanner-gen.go index 47978dd7c01..1ddd77058fe 100644 --- a/spanner/v1/spanner-gen.go +++ b/spanner/v1/spanner-gen.go @@ -447,6 +447,10 @@ func (s AdaptMessageRequest) MarshalJSON() ([]byte, error) { // AdaptMessageResponse: Message sent by the adapter to the client. type AdaptMessageResponse struct { + // Last: Optional. Indicates whether this is the last AdaptMessageResponse in + // the stream. This field may be optionally set by the server. Clients should + // not rely on this field being set in all cases. + Last bool `json:"last,omitempty"` // Payload: Optional. Uninterpreted bytes from the underlying wire protocol. Payload string `json:"payload,omitempty"` // StateUpdates: Optional. Opaque state updates to be applied by the client. @@ -454,15 +458,15 @@ type AdaptMessageResponse struct { // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "Payload") to unconditionally + // ForceSendFields is a list of field names (e.g. "Last") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Payload") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See + // NullFields is a list of field names (e.g. "Last") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -755,9 +759,9 @@ type Backup struct { // ordering of backups in the chain can be determined by ordering the backup // `version_time`. IncrementalBackupChainId string `json:"incrementalBackupChainId,omitempty"` - // InstancePartitions: Output only. The instance partition(s) storing the - // backup. This is the same as the list of the instance partition(s) that the - // database had footprint in at the backup's `version_time`. + // InstancePartitions: Output only. The instance partition storing the backup. + // This is the same as the list of the instance partitions that the database + // recorded at the backup's `version_time`. InstancePartitions []*BackupInstancePartition `json:"instancePartitions,omitempty"` // MaxExpireTime: Output only. The max allowed expiration time of the backup, // with microseconds granularity. A backup's expiration time can be configured @@ -1430,6 +1434,11 @@ type CommitResponse struct { // PrecommitToken: If specified, transaction has not committed yet. You must // retry the commit with the new precommit token. PrecommitToken *MultiplexedSessionPrecommitToken `json:"precommitToken,omitempty"` + // SnapshotTimestamp: If `TransactionOptions.isolation_level` is set to + // `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the + // timestamp at which all reads in the transaction ran. This timestamp is never + // returned. + SnapshotTimestamp string `json:"snapshotTimestamp,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` @@ -1543,10 +1552,15 @@ type CopyBackupEncryptionConfig struct { // "GOOGLE_DEFAULT_ENCRYPTION" - Use Google default encryption. // "CUSTOMER_MANAGED_ENCRYPTION" - Use customer managed encryption. If // specified, either `kms_key_name` or `kms_key_names` must contain valid Cloud - // KMS key(s). + // KMS keys. EncryptionType string `json:"encryptionType,omitempty"` - // KmsKeyName: Optional. The Cloud KMS key that will be used to protect the - // backup. This field should be set only when encryption_type is + // KmsKeyName: Optional. This field is maintained for backwards compatibility. + // For new callers, we recommend using `kms_key_names` to specify the KMS key. + // Only use `kms_key_name` if the location of the KMS key matches the database + // instance's configuration (location) exactly. For example, if the KMS + // location is in `us-central1` or `nam3`, then the database instance must also + // be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + // decrypt the restored database. Set this field only when encryption_type is // `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form // `projects//locations//keyRings//cryptoKeys/`. KmsKeyName string `json:"kmsKeyName,omitempty"` @@ -1676,8 +1690,13 @@ type CreateBackupEncryptionConfig struct { // "CUSTOMER_MANAGED_ENCRYPTION" - Use customer managed encryption. If // specified, `kms_key_name` must contain a valid Cloud KMS key. EncryptionType string `json:"encryptionType,omitempty"` - // KmsKeyName: Optional. The Cloud KMS key that will be used to protect the - // backup. This field should be set only when encryption_type is + // KmsKeyName: Optional. This field is maintained for backwards compatibility. + // For new callers, we recommend using `kms_key_names` to specify the KMS key. + // Only use `kms_key_name` if the location of the KMS key matches the database + // instance's configuration (location) exactly. For example, if the KMS + // location is in `us-central1` or `nam3`, then the database instance must also + // be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + // decrypt the restored database. Set this field only when encryption_type is // `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form // `projects//locations//keyRings//cryptoKeys/`. KmsKeyName string `json:"kmsKeyName,omitempty"` @@ -2344,17 +2363,17 @@ func (s DatabaseRole) MarshalJSON() ([]byte, error) { // This proto is used to display the brief info of the DDL statement for the // operation UpdateDatabaseDdl. type DdlStatementActionInfo struct { - // Action: The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, - // etc. This field is a non-empty string. + // Action: The action for the DDL statement, for example, CREATE, ALTER, DROP, + // GRANT, etc. This field is a non-empty string. Action string `json:"action,omitempty"` - // EntityNames: The entity name(s) being operated on the DDL statement. E.g. 1. - // For statement "CREATE TABLE t1(...)", `entity_names` = ["t1"]. 2. For - // statement "GRANT ROLE r1, r2 ...", `entity_names` = ["r1", "r2"]. 3. For - // statement "ANALYZE", `entity_names` = []. + // EntityNames: The entity names being operated on the DDL statement. For + // example, 1. For statement "CREATE TABLE t1(...)", `entity_names` = ["t1"]. + // 2. For statement "GRANT ROLE r1, r2 ...", `entity_names` = ["r1", "r2"]. 3. + // For statement "ANALYZE", `entity_names` = []. EntityNames []string `json:"entityNames,omitempty"` - // EntityType: The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, - // etc. This field can be empty string for some DDL statement, e.g. for - // statement "ANALYZE", `entity_type` = "". + // EntityType: The entity type for the DDL statement, for example, TABLE, + // INDEX, VIEW, etc. This field can be empty string for some DDL statement, for + // example, for statement "ANALYZE", `entity_type` = "". EntityType string `json:"entityType,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -3473,11 +3492,11 @@ func (s InstanceConfig) MarshalJSON() ([]byte, error) { type InstanceEncryptionConfig struct { // KmsKeyName: Optional. This field is maintained for backwards compatibility. // For new callers, we recommend using `kms_key_names` to specify the KMS key. - // `kms_key_name` should only be used if the location of the KMS key matches - // the database instance’s configuration (location) exactly. E.g. The KMS - // location is in us-central1 or nam3 and the database instance is also in - // us-central1 or nam3. The Cloud KMS key to be used for encrypting and - // decrypting the database. Values are of the form + // Only use `kms_key_name` if the location of the KMS key matches the database + // instance's configuration (location) exactly. For example, if the KMS + // location is in `us-central1` or `nam3`, then the database instance must also + // be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + // decrypt the restored database. Values are of the form // `projects//locations//keyRings//cryptoKeys/`. KmsKeyName string `json:"kmsKeyName,omitempty"` // KmsKeyNames: Optional. Specifies the KMS configuration for one or more keys @@ -3631,7 +3650,7 @@ func (s InstancePartition) MarshalJSON() ([]byte, error) { // InstanceReplicaSelection: ReplicaSelection identifies replicas with common // properties. type InstanceReplicaSelection struct { - // Location: Required. Name of the location of the replicas (e.g., + // Location: Required. Name of the location of the replicas (for example, // "us-central1"). Location string `json:"location,omitempty"` // ForceSendFields is a list of field names (e.g. "Location") to @@ -5960,8 +5979,13 @@ type RestoreDatabaseEncryptionConfig struct { // "CUSTOMER_MANAGED_ENCRYPTION" - Use customer managed encryption. If // specified, `kms_key_name` must must contain a valid Cloud KMS key. EncryptionType string `json:"encryptionType,omitempty"` - // KmsKeyName: Optional. The Cloud KMS key that will be used to encrypt/decrypt - // the restored database. This field should be set only when encryption_type is + // KmsKeyName: Optional. This field is maintained for backwards compatibility. + // For new callers, we recommend using `kms_key_names` to specify the KMS key. + // Only use `kms_key_name` if the location of the KMS key matches the database + // instance's configuration (location) exactly. For example, if the KMS + // location is in `us-central1` or `nam3`, then the database instance must also + // be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + // decrypt the restored database. Set this field only when encryption_type is // `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form // `projects//locations//keyRings//cryptoKeys/`. KmsKeyName string `json:"kmsKeyName,omitempty"` @@ -6416,7 +6440,7 @@ func (s ShortRepresentation) MarshalJSON() ([]byte, error) { // SingleRegionQuorum: Message type for a single-region quorum. type SingleRegionQuorum struct { - // ServingLocation: Required. The location of the serving region, e.g. + // ServingLocation: Required. The location of the serving region, for example, // "us-central1". The location must be one of the regions within the // dual-region instance configuration of your database. The list of valid // locations is available using the GetInstanceConfig API. This should only be @@ -6876,9 +6900,9 @@ type UpdateDatabaseDdlMetadata struct { // Statements: For an update this list contains all the statements. For an // individual statement, this list contains only that statement. Statements []string `json:"statements,omitempty"` - // Throttled: Output only. When true, indicates that the operation is throttled - // e.g. due to resource constraints. When resources become available the - // operation will resume and this field will be false again. + // Throttled: Output only. When true, indicates that the operation is + // throttled, for example, due to resource constraints. When resources become + // available the operation will resume and this field will be false again. Throttled bool `json:"throttled,omitempty"` // ForceSendFields is a list of field names (e.g. "Actions") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -6902,13 +6926,14 @@ func (s UpdateDatabaseDdlMetadata) MarshalJSON() ([]byte, error) { // in order but not necessarily all at once, to the database schema at some // point (or points) in the future. The server checks that the statements are // executable (syntactically valid, name tables that exist, etc.) before -// enqueueing them, but they may still fail upon later execution (e.g., if a -// statement from another batch of statements is applied first and it conflicts -// in some way, or if there is some data-related problem like a `NULL` value in -// a column to which `NOT NULL` would be added). If a statement fails, all -// subsequent statements in the batch are automatically cancelled. Each batch -// of statements is assigned a name which can be used with the Operations API -// to monitor progress. See the operation_id field for more details. +// enqueueing them, but they may still fail upon later execution (for example, +// if a statement from another batch of statements is applied first and it +// conflicts in some way, or if there is some data-related problem like a +// `NULL` value in a column to which `NOT NULL` would be added). If a statement +// fails, all subsequent statements in the batch are automatically cancelled. +// Each batch of statements is assigned a name which can be used with the +// Operations API to monitor progress. See the operation_id field for more +// details. type UpdateDatabaseDdlRequest struct { // OperationId: If empty, the new update request is assigned an // automatically-generated operation ID. Otherwise, `operation_id` is used to @@ -10466,10 +10491,10 @@ type ProjectsInstancesBackupsCreateCall struct { // one pending backup creation per database. Backup creation of different // databases can run concurrently. // -// - parent: The name of the instance in which the backup will be created. This -// must be the same instance that contains the database the backup will be -// created from. The backup will be stored in the location(s) specified in -// the instance configuration of this instance. Values are of the form +// - parent: The name of the instance in which the backup is created. This must +// be the same instance that contains the database the backup is created +// from. The backup will be stored in the locations specified in the instance +// configuration of this instance. Values are of the form // `projects//instances/`. func (r *ProjectsInstancesBackupsService) Create(parent string, backup *Backup) *ProjectsInstancesBackupsCreateCall { c := &ProjectsInstancesBackupsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -10509,10 +10534,15 @@ func (c *ProjectsInstancesBackupsCreateCall) EncryptionConfigEncryptionType(encr } // EncryptionConfigKmsKeyName sets the optional parameter -// "encryptionConfig.kmsKeyName": The Cloud KMS key that will be used to -// protect the backup. This field should be set only when encryption_type is -// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form -// `projects//locations//keyRings//cryptoKeys/`. +// "encryptionConfig.kmsKeyName": This field is maintained for backwards +// compatibility. For new callers, we recommend using `kms_key_names` to +// specify the KMS key. Only use `kms_key_name` if the location of the KMS key +// matches the database instance's configuration (location) exactly. For +// example, if the KMS location is in `us-central1` or `nam3`, then the +// database instance must also be in `us-central1` or `nam3`. The Cloud KMS key +// that is used to encrypt and decrypt the restored database. Set this field +// only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of +// the form `projects//locations//keyRings//cryptoKeys/`. func (c *ProjectsInstancesBackupsCreateCall) EncryptionConfigKmsKeyName(encryptionConfigKmsKeyName string) *ProjectsInstancesBackupsCreateCall { c.urlParams_.Set("encryptionConfig.kmsKeyName", encryptionConfigKmsKeyName) return c @@ -11145,11 +11175,11 @@ func (r *ProjectsInstancesBackupsService) Patch(nameid string, backup *Backup) * } // UpdateMask sets the optional parameter "updateMask": Required. A mask -// specifying which fields (e.g. `expire_time`) in the Backup resource should -// be updated. This mask is relative to the Backup resource, not to the request -// message. The field mask must always be specified; this prevents any future -// fields from being erased accidentally by clients that do not know about -// them. +// specifying which fields (for example, `expire_time`) in the backup resource +// should be updated. This mask is relative to the backup resource, not to the +// request message. The field mask must always be specified; this prevents any +// future fields from being erased accidentally by clients that do not know +// about them. func (c *ProjectsInstancesBackupsPatchCall) UpdateMask(updateMask string) *ProjectsInstancesBackupsPatchCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -13657,8 +13687,8 @@ type ProjectsInstancesDatabasesUpdateDdlCall struct { // UpdateDdl: Updates the schema of a Cloud Spanner database by // creating/altering/dropping tables, columns, indexes, etc. The returned // long-running operation will have a name of the format `/operations/` and can -// be used to track execution of the schema change(s). The metadata field type -// is UpdateDatabaseDdlMetadata. The operation has no response. +// be used to track execution of the schema changes. The metadata field type is +// UpdateDatabaseDdlMetadata. The operation has no response. // // - database: The database to update. func (r *ProjectsInstancesDatabasesService) UpdateDdl(database string, updatedatabaseddlrequest *UpdateDatabaseDdlRequest) *ProjectsInstancesDatabasesUpdateDdlCall { diff --git a/vmwareengine/v1/vmwareengine-api.json b/vmwareengine/v1/vmwareengine-api.json index 9e1b8b820fa..f8c1b288840 100644 --- a/vmwareengine/v1/vmwareengine-api.json +++ b/vmwareengine/v1/vmwareengine-api.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3396,7 +3396,7 @@ } } }, - "revision": "20250811", + "revision": "20250912", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AcceleratePrivateCloudDeletionRequest": { diff --git a/vmwareengine/v1/vmwareengine-gen.go b/vmwareengine/v1/vmwareengine-gen.go index 186ee917511..288f9a60e39 100644 --- a/vmwareengine/v1/vmwareengine-gen.go +++ b/vmwareengine/v1/vmwareengine-gen.go @@ -4228,9 +4228,9 @@ func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall return c } -// ExtraLocationTypes sets the optional parameter "extraLocationTypes": A list -// of extra location types that should be used as conditions for controlling -// the visibility of the locations. +// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Unless +// explicitly documented otherwise, don't use this unsupported field which is +// primarily intended for internal usage. func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall { c.urlParams_.SetMulti("extraLocationTypes", append([]string{}, extraLocationTypes...)) return c