diff --git a/api-list.json b/api-list.json index c53f81a5744..4fea36cac29 100644 --- a/api-list.json +++ b/api-list.json @@ -5962,6 +5962,36 @@ "documentationLink": "https://cloud.google.com/workflows", "preferred": true }, + { + "kind": "discovery#directoryItem", + "id": "workloadmanager:v1", + "name": "workloadmanager", + "version": "v1", + "title": "Workload Manager API", + "description": "", + "discoveryRestUrl": "https://workloadmanager.googleapis.com/$discovery/rest?version=v1", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://g3doc.corp.google.com/company/teams/compute-fe/index.md?cl=head", + "preferred": true + }, + { + "kind": "discovery#directoryItem", + "id": "workstations:v1beta", + "name": "workstations", + "version": "v1beta", + "title": "Cloud Workstations API", + "description": "", + "discoveryRestUrl": "https://workstations.googleapis.com/$discovery/rest?version=v1beta", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://cloud.google.com/workstations", + "preferred": true + }, { "kind": "discovery#directoryItem", "id": "youtube:v3", diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json index 5977d71645c..7ac924bd1f7 100644 --- a/appengine/v1/appengine-api.json +++ b/appengine/v1/appengine-api.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20220826", + "revision": "20221205", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3059,6 +3059,122 @@ }, "type": "object" }, + "ProjectEvent": { + "description": "The request sent to CLHs during project events.", + "id": "ProjectEvent", + "properties": { + "eventId": { + "description": "The unique ID for this project event. CLHs can use this value to dedup repeated calls. required", + "type": "string" + }, + "phase": { + "enum": [ + "UNKNOWN", + "BEFORE_RESOURCE_HANDLING", + "AFTER_RESOURCE_HANDLING" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "projectMetadata": { + "$ref": "ProjectsMetadata", + "description": "The projects metadata for this project. required" + }, + "state": { + "$ref": "ProjectState", + "description": "The state of the project that led to this event." + } + }, + "type": "object" + }, + "ProjectState": { + "description": "ProjectState contains the externally-visible project state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the project state.", + "id": "ProjectState", + "properties": { + "currentReasons": { + "$ref": "Reasons" + }, + "previousReasons": { + "$ref": "Reasons", + "description": "The previous and current reasons for a project state will be sent for a project event. CLHs that need to know the signal that caused the project event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.Reasons fields are deprecated. New tenants should only use the state field. If you must know the reason(s) behind a specific state, please consult with CCFE team first (cloud-ccfe-discuss@google.com)." + }, + "state": { + "description": "The current state of the project. This state is the culmination of all of the opinions from external systems that CCFE knows about of the project.", + "enum": [ + "UNKNOWN_STATE", + "ON", + "OFF", + "DELETED" + ], + "enumDescriptions": [ + "A project should never be in an unknown state. Receipt of a project with this state is an error.", + "CCFE considers the project to be serving or transitioning into serving.", + "CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.", + "This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProjectsMetadata": { + "description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).", + "id": "ProjectsMetadata", + "properties": { + "consumerProjectId": { + "description": "The consumer project id.", + "type": "string" + }, + "consumerProjectNumber": { + "description": "The consumer project number.", + "format": "int64", + "type": "string" + }, + "consumerProjectState": { + "description": "The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel.", + "enum": [ + "UNKNOWN_STATE", + "ON", + "OFF", + "DELETED" + ], + "enumDescriptions": [ + "A project should never be in an unknown state. Receipt of a project with this state is an error.", + "CCFE considers the project to be serving or transitioning into serving.", + "CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.", + "This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached." + ], + "type": "string" + }, + "p4ServiceAccount": { + "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", + "type": "string" + }, + "producerProjectId": { + "description": "The producer project id.", + "type": "string" + }, + "producerProjectNumber": { + "description": "The producer project number.", + "format": "int64", + "type": "string" + }, + "tenantProjectId": { + "description": "The tenant project id.", + "type": "string" + }, + "tenantProjectNumber": { + "description": "The tenant project number.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ReadinessCheck": { "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.", "id": "ReadinessCheck", @@ -3099,6 +3215,81 @@ }, "type": "object" }, + "Reasons": { + "description": "Projects transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)", + "id": "Reasons", + "properties": { + "abuse": { + "enum": [ + "ABUSE_UNKNOWN_REASON", + "ABUSE_CONTROL_PLANE_SYNC", + "SUSPEND", + "REINSTATE" + ], + "enumDescriptions": [ + "An unknown reason indicates that the abuse system has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "If a project is deemed abusive we receive a suspend signal. Suspend is a reason to put the project into an INTERNAL_OFF state.", + "Projects that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the project. Reinstate is a reason to put the project into an ON state." + ], + "type": "string" + }, + "billing": { + "enum": [ + "BILLING_UNKNOWN_REASON", + "BILLING_CONTROL_PLANE_SYNC", + "PROBATION", + "CLOSE", + "OPEN" + ], + "enumDescriptions": [ + "An unknown reason indicates that the billing system has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "Minor infractions cause a probation signal to be sent. Probation is a reason to put the project into a ON state even though it is a negative signal. CCFE will block mutations for this project while it is on billing probation, but the CLH is expected to serve non-mutation requests.", + "When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the project into an INTERNAL_OFF state.", + "Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the project into an ON state." + ], + "type": "string" + }, + "dataGovernance": { + "enum": [ + "DATA_GOVERNANCE_UNKNOWN_REASON", + "DATA_GOVERNANCE_CONTROL_PLANE_SYNC", + "HIDE", + "UNHIDE", + "PURGE" + ], + "enumDescriptions": [ + "An unknown reason indicates that data governance has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "When a project is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the project in an INTERNAL_OFF state.", + "The decision to un-delete a project can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the project in an ON state.", + "After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the project in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics." + ], + "type": "string" + }, + "serviceManagement": { + "enum": [ + "SERVICE_MANAGEMENT_UNKNOWN_REASON", + "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC", + "ACTIVATION", + "PREPARE_DEACTIVATION", + "ABORT_DEACTIVATION", + "COMMIT_DEACTIVATION" + ], + "enumDescriptions": [ + "An unknown reason indicates that we have not received a signal from service management about this project. Since projects are created by request of service management, this reason should never be set.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "When a customer activates an API CCFE notifies the CLH and sets the project to the ON state.", + "When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the project in a EXTERNAL_OFF state.", + "If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the project in an ON state.", + "If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the project in a DELETED state." + ], + "type": "string" + } + }, + "type": "object" + }, "RepairApplicationRequest": { "description": "Request message for 'Applications.RepairApplication'.", "id": "RepairApplicationRequest", diff --git a/appengine/v1/appengine-gen.go b/appengine/v1/appengine-gen.go index 94504c2bb04..f259e8a3ac3 100644 --- a/appengine/v1/appengine-gen.go +++ b/appengine/v1/appengine-gen.go @@ -2757,6 +2757,200 @@ func (s *OperationMetadataV1Beta) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ProjectEvent: The request sent to CLHs during project events. +type ProjectEvent struct { + // EventId: The unique ID for this project event. CLHs can use this + // value to dedup repeated calls. required + EventId string `json:"eventId,omitempty"` + + // Possible values: + // "UNKNOWN" + // "BEFORE_RESOURCE_HANDLING" + // "AFTER_RESOURCE_HANDLING" + Phase string `json:"phase,omitempty"` + + // ProjectMetadata: The projects metadata for this project. required + ProjectMetadata *ProjectsMetadata `json:"projectMetadata,omitempty"` + + // State: The state of the project that led to this event. + State *ProjectState `json:"state,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EventId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EventId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ProjectEvent) MarshalJSON() ([]byte, error) { + type NoMethod ProjectEvent + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ProjectState: ProjectState contains the externally-visible project +// state that is used to communicate the state and reasoning for that +// state to the CLH. This data is not persisted by CCFE, but is instead +// derived from CCFE's internal representation of the project state. +type ProjectState struct { + CurrentReasons *Reasons `json:"currentReasons,omitempty"` + + // PreviousReasons: The previous and current reasons for a project state + // will be sent for a project event. CLHs that need to know the signal + // that caused the project event to trigger (edges) as opposed to just + // knowing the state can act upon differences in the previous and + // current reasons.Reasons will be provided for every system: service + // management, data governance, abuse, and billing.If this is a + // CCFE-triggered event used for reconciliation then the current reasons + // will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons + // will contain the last known set of non-unknown non-control_plane_sync + // reasons for the state.Reasons fields are deprecated. New tenants + // should only use the state field. If you must know the reason(s) + // behind a specific state, please consult with CCFE team first + // (cloud-ccfe-discuss@google.com). + PreviousReasons *Reasons `json:"previousReasons,omitempty"` + + // State: The current state of the project. This state is the + // culmination of all of the opinions from external systems that CCFE + // knows about of the project. + // + // Possible values: + // "UNKNOWN_STATE" - A project should never be in an unknown state. + // Receipt of a project with this state is an error. + // "ON" - CCFE considers the project to be serving or transitioning + // into serving. + // "OFF" - CCFE considers the project to be in an OFF state. This + // could occur due to various factors. The state could be triggered by + // Google-internal audits (ex. abuse suspension, billing closed) or + // cleanups trigged by compliance systems (ex. data governance hide). + // User-initiated events such as service management deactivation trigger + // a project to an OFF state.CLHs might choose to do nothing in this + // case or to turn off costly resources. CLHs need to consider the + // customer experience if an ON/OFF/ON sequence of state transitions + // occurs vs. the cost of deleting resources, keeping metadata about + // resources, or even keeping resources live for a period of time.CCFE + // will not send any new customer requests to the CLH when the project + // is in an OFF state. However, CCFE will allow all previous customer + // requests relayed to CLH to complete. + // "DELETED" - This state indicates that the project has been (or is + // being) completely removed. This is often due to a data governance + // purge request and therefore resources should be deleted when this + // state is reached. + State string `json:"state,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CurrentReasons") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CurrentReasons") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectState) MarshalJSON() ([]byte, error) { + type NoMethod ProjectState + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ProjectsMetadata: ProjectsMetadata is the metadata CCFE stores about +// the all the relevant projects (tenant, consumer, producer). +type ProjectsMetadata struct { + // ConsumerProjectId: The consumer project id. + ConsumerProjectId string `json:"consumerProjectId,omitempty"` + + // ConsumerProjectNumber: The consumer project number. + ConsumerProjectNumber int64 `json:"consumerProjectNumber,omitempty,string"` + + // ConsumerProjectState: The CCFE state of the consumer project. It is + // the same state that is communicated to the CLH during project events. + // Notice that this field is not set in the DB, it is only set in this + // proto when communicated to CLH in the side channel. + // + // Possible values: + // "UNKNOWN_STATE" - A project should never be in an unknown state. + // Receipt of a project with this state is an error. + // "ON" - CCFE considers the project to be serving or transitioning + // into serving. + // "OFF" - CCFE considers the project to be in an OFF state. This + // could occur due to various factors. The state could be triggered by + // Google-internal audits (ex. abuse suspension, billing closed) or + // cleanups trigged by compliance systems (ex. data governance hide). + // User-initiated events such as service management deactivation trigger + // a project to an OFF state.CLHs might choose to do nothing in this + // case or to turn off costly resources. CLHs need to consider the + // customer experience if an ON/OFF/ON sequence of state transitions + // occurs vs. the cost of deleting resources, keeping metadata about + // resources, or even keeping resources live for a period of time.CCFE + // will not send any new customer requests to the CLH when the project + // is in an OFF state. However, CCFE will allow all previous customer + // requests relayed to CLH to complete. + // "DELETED" - This state indicates that the project has been (or is + // being) completely removed. This is often due to a data governance + // purge request and therefore resources should be deleted when this + // state is reached. + ConsumerProjectState string `json:"consumerProjectState,omitempty"` + + // P4ServiceAccount: The service account authorized to operate on the + // consumer project. Note: CCFE only propagates P4SA with default tag to + // CLH. + P4ServiceAccount string `json:"p4ServiceAccount,omitempty"` + + // ProducerProjectId: The producer project id. + ProducerProjectId string `json:"producerProjectId,omitempty"` + + // ProducerProjectNumber: The producer project number. + ProducerProjectNumber int64 `json:"producerProjectNumber,omitempty,string"` + + // TenantProjectId: The tenant project id. + TenantProjectId string `json:"tenantProjectId,omitempty"` + + // TenantProjectNumber: The tenant project number. + TenantProjectNumber int64 `json:"tenantProjectNumber,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ConsumerProjectId") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ConsumerProjectId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod ProjectsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ReadinessCheck: Readiness checking configuration for VM instances. // Unhealthy instances are removed from traffic rotation. type ReadinessCheck struct { @@ -2810,6 +3004,115 @@ func (s *ReadinessCheck) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Reasons: Projects transition between and within states based on +// reasons sent from various systems. CCFE will provide the CLH with +// reasons for the current state per system.The current systems that +// CCFE supports are: Service Management (Inception) Data Governance +// (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) +type Reasons struct { + // Possible values: + // "ABUSE_UNKNOWN_REASON" - An unknown reason indicates that the abuse + // system has not sent a signal for this project. + // "ABUSE_CONTROL_PLANE_SYNC" - Due to various reasons CCFE might + // proactively restate a project state to a CLH to ensure that the CLH + // and CCFE are both aware of the project state. This reason can be tied + // to any of the states. + // "SUSPEND" - If a project is deemed abusive we receive a suspend + // signal. Suspend is a reason to put the project into an INTERNAL_OFF + // state. + // "REINSTATE" - Projects that were once considered abusive can later + // be deemed non-abusive. When this happens we must reinstate the + // project. Reinstate is a reason to put the project into an ON state. + Abuse string `json:"abuse,omitempty"` + + // Possible values: + // "BILLING_UNKNOWN_REASON" - An unknown reason indicates that the + // billing system has not sent a signal for this project. + // "BILLING_CONTROL_PLANE_SYNC" - Due to various reasons CCFE might + // proactively restate a project state to a CLH to ensure that the CLH + // and CCFE are both aware of the project state. This reason can be tied + // to any of the states. + // "PROBATION" - Minor infractions cause a probation signal to be + // sent. Probation is a reason to put the project into a ON state even + // though it is a negative signal. CCFE will block mutations for this + // project while it is on billing probation, but the CLH is expected to + // serve non-mutation requests. + // "CLOSE" - When a billing account is closed, it is a stronger signal + // about non-payment. Close is a reason to put the project into an + // INTERNAL_OFF state. + // "OPEN" - Consumers can re-open billing accounts and update accounts + // to pull them out of probation. When this happens, we get a signal + // that the account is open. Open is a reason to put the project into an + // ON state. + Billing string `json:"billing,omitempty"` + + // Possible values: + // "DATA_GOVERNANCE_UNKNOWN_REASON" - An unknown reason indicates that + // data governance has not sent a signal for this project. + // "DATA_GOVERNANCE_CONTROL_PLANE_SYNC" - Due to various reasons CCFE + // might proactively restate a project state to a CLH to ensure that the + // CLH and CCFE are both aware of the project state. This reason can be + // tied to any of the states. + // "HIDE" - When a project is deleted we retain some data for a period + // of time to allow the consumer to change their mind. Data governance + // sends a signal to hide the data when this occurs. Hide is a reason to + // put the project in an INTERNAL_OFF state. + // "UNHIDE" - The decision to un-delete a project can be made. When + // this happens data governance tells us to unhide any hidden data. + // Unhide is a reason to put the project in an ON state. + // "PURGE" - After a period of time data must be completely removed + // from our systems. When data governance sends a purge signal we need + // to remove data. Purge is a reason to put the project in a DELETED + // state. Purge is the only event that triggers a delete mutation. All + // other events have update semantics. + DataGovernance string `json:"dataGovernance,omitempty"` + + // Possible values: + // "SERVICE_MANAGEMENT_UNKNOWN_REASON" - An unknown reason indicates + // that we have not received a signal from service management about this + // project. Since projects are created by request of service management, + // this reason should never be set. + // "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC" - Due to various reasons + // CCFE might proactively restate a project state to a CLH to ensure + // that the CLH and CCFE are both aware of the project state. This + // reason can be tied to any of the states. + // "ACTIVATION" - When a customer activates an API CCFE notifies the + // CLH and sets the project to the ON state. + // "PREPARE_DEACTIVATION" - When a customer deactivates and API + // service management starts a two-step process to perform the + // deactivation. The first step is to prepare. Prepare is a reason to + // put the project in a EXTERNAL_OFF state. + // "ABORT_DEACTIVATION" - If the deactivation is cancelled, service + // managed needs to abort the deactivation. Abort is a reason to put the + // project in an ON state. + // "COMMIT_DEACTIVATION" - If the deactivation is followed through + // with, service management needs to finish deactivation. Commit is a + // reason to put the project in a DELETED state. + ServiceManagement string `json:"serviceManagement,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Abuse") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Abuse") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Reasons) MarshalJSON() ([]byte, error) { + type NoMethod Reasons + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // RepairApplicationRequest: Request message for // 'Applications.RepairApplication'. type RepairApplicationRequest struct { diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json index cb1795bae77..7cef5de3887 100644 --- a/appengine/v1alpha/appengine-api.json +++ b/appengine/v1alpha/appengine-api.json @@ -887,7 +887,7 @@ } } }, - "revision": "20220326", + "revision": "20221205", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { @@ -1400,6 +1400,197 @@ }, "type": "object" }, + "ProjectEvent": { + "description": "The request sent to CLHs during project events.", + "id": "ProjectEvent", + "properties": { + "eventId": { + "description": "The unique ID for this project event. CLHs can use this value to dedup repeated calls. required", + "type": "string" + }, + "phase": { + "enum": [ + "UNKNOWN", + "BEFORE_RESOURCE_HANDLING", + "AFTER_RESOURCE_HANDLING" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "projectMetadata": { + "$ref": "ProjectsMetadata", + "description": "The projects metadata for this project. required" + }, + "state": { + "$ref": "ProjectState", + "description": "The state of the project that led to this event." + } + }, + "type": "object" + }, + "ProjectState": { + "description": "ProjectState contains the externally-visible project state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the project state.", + "id": "ProjectState", + "properties": { + "currentReasons": { + "$ref": "Reasons" + }, + "previousReasons": { + "$ref": "Reasons", + "description": "The previous and current reasons for a project state will be sent for a project event. CLHs that need to know the signal that caused the project event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.Reasons fields are deprecated. New tenants should only use the state field. If you must know the reason(s) behind a specific state, please consult with CCFE team first (cloud-ccfe-discuss@google.com)." + }, + "state": { + "description": "The current state of the project. This state is the culmination of all of the opinions from external systems that CCFE knows about of the project.", + "enum": [ + "UNKNOWN_STATE", + "ON", + "OFF", + "DELETED" + ], + "enumDescriptions": [ + "A project should never be in an unknown state. Receipt of a project with this state is an error.", + "CCFE considers the project to be serving or transitioning into serving.", + "CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.", + "This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProjectsMetadata": { + "description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).", + "id": "ProjectsMetadata", + "properties": { + "consumerProjectId": { + "description": "The consumer project id.", + "type": "string" + }, + "consumerProjectNumber": { + "description": "The consumer project number.", + "format": "int64", + "type": "string" + }, + "consumerProjectState": { + "description": "The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel.", + "enum": [ + "UNKNOWN_STATE", + "ON", + "OFF", + "DELETED" + ], + "enumDescriptions": [ + "A project should never be in an unknown state. Receipt of a project with this state is an error.", + "CCFE considers the project to be serving or transitioning into serving.", + "CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.", + "This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached." + ], + "type": "string" + }, + "p4ServiceAccount": { + "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", + "type": "string" + }, + "producerProjectId": { + "description": "The producer project id.", + "type": "string" + }, + "producerProjectNumber": { + "description": "The producer project number.", + "format": "int64", + "type": "string" + }, + "tenantProjectId": { + "description": "The tenant project id.", + "type": "string" + }, + "tenantProjectNumber": { + "description": "The tenant project number.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Reasons": { + "description": "Projects transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)", + "id": "Reasons", + "properties": { + "abuse": { + "enum": [ + "ABUSE_UNKNOWN_REASON", + "ABUSE_CONTROL_PLANE_SYNC", + "SUSPEND", + "REINSTATE" + ], + "enumDescriptions": [ + "An unknown reason indicates that the abuse system has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "If a project is deemed abusive we receive a suspend signal. Suspend is a reason to put the project into an INTERNAL_OFF state.", + "Projects that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the project. Reinstate is a reason to put the project into an ON state." + ], + "type": "string" + }, + "billing": { + "enum": [ + "BILLING_UNKNOWN_REASON", + "BILLING_CONTROL_PLANE_SYNC", + "PROBATION", + "CLOSE", + "OPEN" + ], + "enumDescriptions": [ + "An unknown reason indicates that the billing system has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "Minor infractions cause a probation signal to be sent. Probation is a reason to put the project into a ON state even though it is a negative signal. CCFE will block mutations for this project while it is on billing probation, but the CLH is expected to serve non-mutation requests.", + "When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the project into an INTERNAL_OFF state.", + "Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the project into an ON state." + ], + "type": "string" + }, + "dataGovernance": { + "enum": [ + "DATA_GOVERNANCE_UNKNOWN_REASON", + "DATA_GOVERNANCE_CONTROL_PLANE_SYNC", + "HIDE", + "UNHIDE", + "PURGE" + ], + "enumDescriptions": [ + "An unknown reason indicates that data governance has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "When a project is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the project in an INTERNAL_OFF state.", + "The decision to un-delete a project can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the project in an ON state.", + "After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the project in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics." + ], + "type": "string" + }, + "serviceManagement": { + "enum": [ + "SERVICE_MANAGEMENT_UNKNOWN_REASON", + "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC", + "ACTIVATION", + "PREPARE_DEACTIVATION", + "ABORT_DEACTIVATION", + "COMMIT_DEACTIVATION" + ], + "enumDescriptions": [ + "An unknown reason indicates that we have not received a signal from service management about this project. Since projects are created by request of service management, this reason should never be set.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "When a customer activates an API CCFE notifies the CLH and sets the project to the ON state.", + "When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the project in a EXTERNAL_OFF state.", + "If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the project in an ON state.", + "If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the project in a DELETED state." + ], + "type": "string" + } + }, + "type": "object" + }, "ResourceRecord": { "description": "A DNS resource record.", "id": "ResourceRecord", diff --git a/appengine/v1alpha/appengine-gen.go b/appengine/v1alpha/appengine-gen.go index d3cc035fb4f..a317aea12ca 100644 --- a/appengine/v1alpha/appengine-gen.go +++ b/appengine/v1alpha/appengine-gen.go @@ -1179,6 +1179,309 @@ func (s *OperationMetadataV1Beta) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ProjectEvent: The request sent to CLHs during project events. +type ProjectEvent struct { + // EventId: The unique ID for this project event. CLHs can use this + // value to dedup repeated calls. required + EventId string `json:"eventId,omitempty"` + + // Possible values: + // "UNKNOWN" + // "BEFORE_RESOURCE_HANDLING" + // "AFTER_RESOURCE_HANDLING" + Phase string `json:"phase,omitempty"` + + // ProjectMetadata: The projects metadata for this project. required + ProjectMetadata *ProjectsMetadata `json:"projectMetadata,omitempty"` + + // State: The state of the project that led to this event. + State *ProjectState `json:"state,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EventId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EventId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ProjectEvent) MarshalJSON() ([]byte, error) { + type NoMethod ProjectEvent + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ProjectState: ProjectState contains the externally-visible project +// state that is used to communicate the state and reasoning for that +// state to the CLH. This data is not persisted by CCFE, but is instead +// derived from CCFE's internal representation of the project state. +type ProjectState struct { + CurrentReasons *Reasons `json:"currentReasons,omitempty"` + + // PreviousReasons: The previous and current reasons for a project state + // will be sent for a project event. CLHs that need to know the signal + // that caused the project event to trigger (edges) as opposed to just + // knowing the state can act upon differences in the previous and + // current reasons.Reasons will be provided for every system: service + // management, data governance, abuse, and billing.If this is a + // CCFE-triggered event used for reconciliation then the current reasons + // will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons + // will contain the last known set of non-unknown non-control_plane_sync + // reasons for the state.Reasons fields are deprecated. New tenants + // should only use the state field. If you must know the reason(s) + // behind a specific state, please consult with CCFE team first + // (cloud-ccfe-discuss@google.com). + PreviousReasons *Reasons `json:"previousReasons,omitempty"` + + // State: The current state of the project. This state is the + // culmination of all of the opinions from external systems that CCFE + // knows about of the project. + // + // Possible values: + // "UNKNOWN_STATE" - A project should never be in an unknown state. + // Receipt of a project with this state is an error. + // "ON" - CCFE considers the project to be serving or transitioning + // into serving. + // "OFF" - CCFE considers the project to be in an OFF state. This + // could occur due to various factors. The state could be triggered by + // Google-internal audits (ex. abuse suspension, billing closed) or + // cleanups trigged by compliance systems (ex. data governance hide). + // User-initiated events such as service management deactivation trigger + // a project to an OFF state.CLHs might choose to do nothing in this + // case or to turn off costly resources. CLHs need to consider the + // customer experience if an ON/OFF/ON sequence of state transitions + // occurs vs. the cost of deleting resources, keeping metadata about + // resources, or even keeping resources live for a period of time.CCFE + // will not send any new customer requests to the CLH when the project + // is in an OFF state. However, CCFE will allow all previous customer + // requests relayed to CLH to complete. + // "DELETED" - This state indicates that the project has been (or is + // being) completely removed. This is often due to a data governance + // purge request and therefore resources should be deleted when this + // state is reached. + State string `json:"state,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CurrentReasons") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CurrentReasons") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectState) MarshalJSON() ([]byte, error) { + type NoMethod ProjectState + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ProjectsMetadata: ProjectsMetadata is the metadata CCFE stores about +// the all the relevant projects (tenant, consumer, producer). +type ProjectsMetadata struct { + // ConsumerProjectId: The consumer project id. + ConsumerProjectId string `json:"consumerProjectId,omitempty"` + + // ConsumerProjectNumber: The consumer project number. + ConsumerProjectNumber int64 `json:"consumerProjectNumber,omitempty,string"` + + // ConsumerProjectState: The CCFE state of the consumer project. It is + // the same state that is communicated to the CLH during project events. + // Notice that this field is not set in the DB, it is only set in this + // proto when communicated to CLH in the side channel. + // + // Possible values: + // "UNKNOWN_STATE" - A project should never be in an unknown state. + // Receipt of a project with this state is an error. + // "ON" - CCFE considers the project to be serving or transitioning + // into serving. + // "OFF" - CCFE considers the project to be in an OFF state. This + // could occur due to various factors. The state could be triggered by + // Google-internal audits (ex. abuse suspension, billing closed) or + // cleanups trigged by compliance systems (ex. data governance hide). + // User-initiated events such as service management deactivation trigger + // a project to an OFF state.CLHs might choose to do nothing in this + // case or to turn off costly resources. CLHs need to consider the + // customer experience if an ON/OFF/ON sequence of state transitions + // occurs vs. the cost of deleting resources, keeping metadata about + // resources, or even keeping resources live for a period of time.CCFE + // will not send any new customer requests to the CLH when the project + // is in an OFF state. However, CCFE will allow all previous customer + // requests relayed to CLH to complete. + // "DELETED" - This state indicates that the project has been (or is + // being) completely removed. This is often due to a data governance + // purge request and therefore resources should be deleted when this + // state is reached. + ConsumerProjectState string `json:"consumerProjectState,omitempty"` + + // P4ServiceAccount: The service account authorized to operate on the + // consumer project. Note: CCFE only propagates P4SA with default tag to + // CLH. + P4ServiceAccount string `json:"p4ServiceAccount,omitempty"` + + // ProducerProjectId: The producer project id. + ProducerProjectId string `json:"producerProjectId,omitempty"` + + // ProducerProjectNumber: The producer project number. + ProducerProjectNumber int64 `json:"producerProjectNumber,omitempty,string"` + + // TenantProjectId: The tenant project id. + TenantProjectId string `json:"tenantProjectId,omitempty"` + + // TenantProjectNumber: The tenant project number. + TenantProjectNumber int64 `json:"tenantProjectNumber,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ConsumerProjectId") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ConsumerProjectId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod ProjectsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Reasons: Projects transition between and within states based on +// reasons sent from various systems. CCFE will provide the CLH with +// reasons for the current state per system.The current systems that +// CCFE supports are: Service Management (Inception) Data Governance +// (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) +type Reasons struct { + // Possible values: + // "ABUSE_UNKNOWN_REASON" - An unknown reason indicates that the abuse + // system has not sent a signal for this project. + // "ABUSE_CONTROL_PLANE_SYNC" - Due to various reasons CCFE might + // proactively restate a project state to a CLH to ensure that the CLH + // and CCFE are both aware of the project state. This reason can be tied + // to any of the states. + // "SUSPEND" - If a project is deemed abusive we receive a suspend + // signal. Suspend is a reason to put the project into an INTERNAL_OFF + // state. + // "REINSTATE" - Projects that were once considered abusive can later + // be deemed non-abusive. When this happens we must reinstate the + // project. Reinstate is a reason to put the project into an ON state. + Abuse string `json:"abuse,omitempty"` + + // Possible values: + // "BILLING_UNKNOWN_REASON" - An unknown reason indicates that the + // billing system has not sent a signal for this project. + // "BILLING_CONTROL_PLANE_SYNC" - Due to various reasons CCFE might + // proactively restate a project state to a CLH to ensure that the CLH + // and CCFE are both aware of the project state. This reason can be tied + // to any of the states. + // "PROBATION" - Minor infractions cause a probation signal to be + // sent. Probation is a reason to put the project into a ON state even + // though it is a negative signal. CCFE will block mutations for this + // project while it is on billing probation, but the CLH is expected to + // serve non-mutation requests. + // "CLOSE" - When a billing account is closed, it is a stronger signal + // about non-payment. Close is a reason to put the project into an + // INTERNAL_OFF state. + // "OPEN" - Consumers can re-open billing accounts and update accounts + // to pull them out of probation. When this happens, we get a signal + // that the account is open. Open is a reason to put the project into an + // ON state. + Billing string `json:"billing,omitempty"` + + // Possible values: + // "DATA_GOVERNANCE_UNKNOWN_REASON" - An unknown reason indicates that + // data governance has not sent a signal for this project. + // "DATA_GOVERNANCE_CONTROL_PLANE_SYNC" - Due to various reasons CCFE + // might proactively restate a project state to a CLH to ensure that the + // CLH and CCFE are both aware of the project state. This reason can be + // tied to any of the states. + // "HIDE" - When a project is deleted we retain some data for a period + // of time to allow the consumer to change their mind. Data governance + // sends a signal to hide the data when this occurs. Hide is a reason to + // put the project in an INTERNAL_OFF state. + // "UNHIDE" - The decision to un-delete a project can be made. When + // this happens data governance tells us to unhide any hidden data. + // Unhide is a reason to put the project in an ON state. + // "PURGE" - After a period of time data must be completely removed + // from our systems. When data governance sends a purge signal we need + // to remove data. Purge is a reason to put the project in a DELETED + // state. Purge is the only event that triggers a delete mutation. All + // other events have update semantics. + DataGovernance string `json:"dataGovernance,omitempty"` + + // Possible values: + // "SERVICE_MANAGEMENT_UNKNOWN_REASON" - An unknown reason indicates + // that we have not received a signal from service management about this + // project. Since projects are created by request of service management, + // this reason should never be set. + // "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC" - Due to various reasons + // CCFE might proactively restate a project state to a CLH to ensure + // that the CLH and CCFE are both aware of the project state. This + // reason can be tied to any of the states. + // "ACTIVATION" - When a customer activates an API CCFE notifies the + // CLH and sets the project to the ON state. + // "PREPARE_DEACTIVATION" - When a customer deactivates and API + // service management starts a two-step process to perform the + // deactivation. The first step is to prepare. Prepare is a reason to + // put the project in a EXTERNAL_OFF state. + // "ABORT_DEACTIVATION" - If the deactivation is cancelled, service + // managed needs to abort the deactivation. Abort is a reason to put the + // project in an ON state. + // "COMMIT_DEACTIVATION" - If the deactivation is followed through + // with, service management needs to finish deactivation. Commit is a + // reason to put the project in a DELETED state. + ServiceManagement string `json:"serviceManagement,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Abuse") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Abuse") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Reasons) MarshalJSON() ([]byte, error) { + type NoMethod Reasons + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ResourceRecord: A DNS resource record. type ResourceRecord struct { // Name: Relative name of the object affected by this record. Only diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json index 6a8a22fba72..b33ca8dc9b4 100644 --- a/appengine/v1beta/appengine-api.json +++ b/appengine/v1beta/appengine-api.json @@ -1898,7 +1898,7 @@ } } }, - "revision": "20221017", + "revision": "20221205", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3419,6 +3419,122 @@ }, "type": "object" }, + "ProjectEvent": { + "description": "The request sent to CLHs during project events.", + "id": "ProjectEvent", + "properties": { + "eventId": { + "description": "The unique ID for this project event. CLHs can use this value to dedup repeated calls. required", + "type": "string" + }, + "phase": { + "enum": [ + "UNKNOWN", + "BEFORE_RESOURCE_HANDLING", + "AFTER_RESOURCE_HANDLING" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "projectMetadata": { + "$ref": "ProjectsMetadata", + "description": "The projects metadata for this project. required" + }, + "state": { + "$ref": "ProjectState", + "description": "The state of the project that led to this event." + } + }, + "type": "object" + }, + "ProjectState": { + "description": "ProjectState contains the externally-visible project state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the project state.", + "id": "ProjectState", + "properties": { + "currentReasons": { + "$ref": "Reasons" + }, + "previousReasons": { + "$ref": "Reasons", + "description": "The previous and current reasons for a project state will be sent for a project event. CLHs that need to know the signal that caused the project event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.Reasons fields are deprecated. New tenants should only use the state field. If you must know the reason(s) behind a specific state, please consult with CCFE team first (cloud-ccfe-discuss@google.com)." + }, + "state": { + "description": "The current state of the project. This state is the culmination of all of the opinions from external systems that CCFE knows about of the project.", + "enum": [ + "UNKNOWN_STATE", + "ON", + "OFF", + "DELETED" + ], + "enumDescriptions": [ + "A project should never be in an unknown state. Receipt of a project with this state is an error.", + "CCFE considers the project to be serving or transitioning into serving.", + "CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.", + "This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProjectsMetadata": { + "description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).", + "id": "ProjectsMetadata", + "properties": { + "consumerProjectId": { + "description": "The consumer project id.", + "type": "string" + }, + "consumerProjectNumber": { + "description": "The consumer project number.", + "format": "int64", + "type": "string" + }, + "consumerProjectState": { + "description": "The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel.", + "enum": [ + "UNKNOWN_STATE", + "ON", + "OFF", + "DELETED" + ], + "enumDescriptions": [ + "A project should never be in an unknown state. Receipt of a project with this state is an error.", + "CCFE considers the project to be serving or transitioning into serving.", + "CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.", + "This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached." + ], + "type": "string" + }, + "p4ServiceAccount": { + "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", + "type": "string" + }, + "producerProjectId": { + "description": "The producer project id.", + "type": "string" + }, + "producerProjectNumber": { + "description": "The producer project number.", + "format": "int64", + "type": "string" + }, + "tenantProjectId": { + "description": "The tenant project id.", + "type": "string" + }, + "tenantProjectNumber": { + "description": "The tenant project number.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ReadinessCheck": { "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.", "id": "ReadinessCheck", @@ -3459,6 +3575,81 @@ }, "type": "object" }, + "Reasons": { + "description": "Projects transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)", + "id": "Reasons", + "properties": { + "abuse": { + "enum": [ + "ABUSE_UNKNOWN_REASON", + "ABUSE_CONTROL_PLANE_SYNC", + "SUSPEND", + "REINSTATE" + ], + "enumDescriptions": [ + "An unknown reason indicates that the abuse system has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "If a project is deemed abusive we receive a suspend signal. Suspend is a reason to put the project into an INTERNAL_OFF state.", + "Projects that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the project. Reinstate is a reason to put the project into an ON state." + ], + "type": "string" + }, + "billing": { + "enum": [ + "BILLING_UNKNOWN_REASON", + "BILLING_CONTROL_PLANE_SYNC", + "PROBATION", + "CLOSE", + "OPEN" + ], + "enumDescriptions": [ + "An unknown reason indicates that the billing system has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "Minor infractions cause a probation signal to be sent. Probation is a reason to put the project into a ON state even though it is a negative signal. CCFE will block mutations for this project while it is on billing probation, but the CLH is expected to serve non-mutation requests.", + "When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the project into an INTERNAL_OFF state.", + "Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the project into an ON state." + ], + "type": "string" + }, + "dataGovernance": { + "enum": [ + "DATA_GOVERNANCE_UNKNOWN_REASON", + "DATA_GOVERNANCE_CONTROL_PLANE_SYNC", + "HIDE", + "UNHIDE", + "PURGE" + ], + "enumDescriptions": [ + "An unknown reason indicates that data governance has not sent a signal for this project.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "When a project is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the project in an INTERNAL_OFF state.", + "The decision to un-delete a project can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the project in an ON state.", + "After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the project in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics." + ], + "type": "string" + }, + "serviceManagement": { + "enum": [ + "SERVICE_MANAGEMENT_UNKNOWN_REASON", + "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC", + "ACTIVATION", + "PREPARE_DEACTIVATION", + "ABORT_DEACTIVATION", + "COMMIT_DEACTIVATION" + ], + "enumDescriptions": [ + "An unknown reason indicates that we have not received a signal from service management about this project. Since projects are created by request of service management, this reason should never be set.", + "Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.", + "When a customer activates an API CCFE notifies the CLH and sets the project to the ON state.", + "When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the project in a EXTERNAL_OFF state.", + "If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the project in an ON state.", + "If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the project in a DELETED state." + ], + "type": "string" + } + }, + "type": "object" + }, "RepairApplicationRequest": { "description": "Request message for 'Applications.RepairApplication'.", "id": "RepairApplicationRequest", diff --git a/appengine/v1beta/appengine-gen.go b/appengine/v1beta/appengine-gen.go index 9b858807672..95a73d94bf9 100644 --- a/appengine/v1beta/appengine-gen.go +++ b/appengine/v1beta/appengine-gen.go @@ -2902,6 +2902,200 @@ func (s *OperationMetadataV1Beta) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ProjectEvent: The request sent to CLHs during project events. +type ProjectEvent struct { + // EventId: The unique ID for this project event. CLHs can use this + // value to dedup repeated calls. required + EventId string `json:"eventId,omitempty"` + + // Possible values: + // "UNKNOWN" + // "BEFORE_RESOURCE_HANDLING" + // "AFTER_RESOURCE_HANDLING" + Phase string `json:"phase,omitempty"` + + // ProjectMetadata: The projects metadata for this project. required + ProjectMetadata *ProjectsMetadata `json:"projectMetadata,omitempty"` + + // State: The state of the project that led to this event. + State *ProjectState `json:"state,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EventId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EventId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ProjectEvent) MarshalJSON() ([]byte, error) { + type NoMethod ProjectEvent + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ProjectState: ProjectState contains the externally-visible project +// state that is used to communicate the state and reasoning for that +// state to the CLH. This data is not persisted by CCFE, but is instead +// derived from CCFE's internal representation of the project state. +type ProjectState struct { + CurrentReasons *Reasons `json:"currentReasons,omitempty"` + + // PreviousReasons: The previous and current reasons for a project state + // will be sent for a project event. CLHs that need to know the signal + // that caused the project event to trigger (edges) as opposed to just + // knowing the state can act upon differences in the previous and + // current reasons.Reasons will be provided for every system: service + // management, data governance, abuse, and billing.If this is a + // CCFE-triggered event used for reconciliation then the current reasons + // will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons + // will contain the last known set of non-unknown non-control_plane_sync + // reasons for the state.Reasons fields are deprecated. New tenants + // should only use the state field. If you must know the reason(s) + // behind a specific state, please consult with CCFE team first + // (cloud-ccfe-discuss@google.com). + PreviousReasons *Reasons `json:"previousReasons,omitempty"` + + // State: The current state of the project. This state is the + // culmination of all of the opinions from external systems that CCFE + // knows about of the project. + // + // Possible values: + // "UNKNOWN_STATE" - A project should never be in an unknown state. + // Receipt of a project with this state is an error. + // "ON" - CCFE considers the project to be serving or transitioning + // into serving. + // "OFF" - CCFE considers the project to be in an OFF state. This + // could occur due to various factors. The state could be triggered by + // Google-internal audits (ex. abuse suspension, billing closed) or + // cleanups trigged by compliance systems (ex. data governance hide). + // User-initiated events such as service management deactivation trigger + // a project to an OFF state.CLHs might choose to do nothing in this + // case or to turn off costly resources. CLHs need to consider the + // customer experience if an ON/OFF/ON sequence of state transitions + // occurs vs. the cost of deleting resources, keeping metadata about + // resources, or even keeping resources live for a period of time.CCFE + // will not send any new customer requests to the CLH when the project + // is in an OFF state. However, CCFE will allow all previous customer + // requests relayed to CLH to complete. + // "DELETED" - This state indicates that the project has been (or is + // being) completely removed. This is often due to a data governance + // purge request and therefore resources should be deleted when this + // state is reached. + State string `json:"state,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CurrentReasons") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CurrentReasons") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectState) MarshalJSON() ([]byte, error) { + type NoMethod ProjectState + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ProjectsMetadata: ProjectsMetadata is the metadata CCFE stores about +// the all the relevant projects (tenant, consumer, producer). +type ProjectsMetadata struct { + // ConsumerProjectId: The consumer project id. + ConsumerProjectId string `json:"consumerProjectId,omitempty"` + + // ConsumerProjectNumber: The consumer project number. + ConsumerProjectNumber int64 `json:"consumerProjectNumber,omitempty,string"` + + // ConsumerProjectState: The CCFE state of the consumer project. It is + // the same state that is communicated to the CLH during project events. + // Notice that this field is not set in the DB, it is only set in this + // proto when communicated to CLH in the side channel. + // + // Possible values: + // "UNKNOWN_STATE" - A project should never be in an unknown state. + // Receipt of a project with this state is an error. + // "ON" - CCFE considers the project to be serving or transitioning + // into serving. + // "OFF" - CCFE considers the project to be in an OFF state. This + // could occur due to various factors. The state could be triggered by + // Google-internal audits (ex. abuse suspension, billing closed) or + // cleanups trigged by compliance systems (ex. data governance hide). + // User-initiated events such as service management deactivation trigger + // a project to an OFF state.CLHs might choose to do nothing in this + // case or to turn off costly resources. CLHs need to consider the + // customer experience if an ON/OFF/ON sequence of state transitions + // occurs vs. the cost of deleting resources, keeping metadata about + // resources, or even keeping resources live for a period of time.CCFE + // will not send any new customer requests to the CLH when the project + // is in an OFF state. However, CCFE will allow all previous customer + // requests relayed to CLH to complete. + // "DELETED" - This state indicates that the project has been (or is + // being) completely removed. This is often due to a data governance + // purge request and therefore resources should be deleted when this + // state is reached. + ConsumerProjectState string `json:"consumerProjectState,omitempty"` + + // P4ServiceAccount: The service account authorized to operate on the + // consumer project. Note: CCFE only propagates P4SA with default tag to + // CLH. + P4ServiceAccount string `json:"p4ServiceAccount,omitempty"` + + // ProducerProjectId: The producer project id. + ProducerProjectId string `json:"producerProjectId,omitempty"` + + // ProducerProjectNumber: The producer project number. + ProducerProjectNumber int64 `json:"producerProjectNumber,omitempty,string"` + + // TenantProjectId: The tenant project id. + TenantProjectId string `json:"tenantProjectId,omitempty"` + + // TenantProjectNumber: The tenant project number. + TenantProjectNumber int64 `json:"tenantProjectNumber,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ConsumerProjectId") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ConsumerProjectId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ProjectsMetadata) MarshalJSON() ([]byte, error) { + type NoMethod ProjectsMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ReadinessCheck: Readiness checking configuration for VM instances. // Unhealthy instances are removed from traffic rotation. type ReadinessCheck struct { @@ -2955,6 +3149,115 @@ func (s *ReadinessCheck) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Reasons: Projects transition between and within states based on +// reasons sent from various systems. CCFE will provide the CLH with +// reasons for the current state per system.The current systems that +// CCFE supports are: Service Management (Inception) Data Governance +// (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) +type Reasons struct { + // Possible values: + // "ABUSE_UNKNOWN_REASON" - An unknown reason indicates that the abuse + // system has not sent a signal for this project. + // "ABUSE_CONTROL_PLANE_SYNC" - Due to various reasons CCFE might + // proactively restate a project state to a CLH to ensure that the CLH + // and CCFE are both aware of the project state. This reason can be tied + // to any of the states. + // "SUSPEND" - If a project is deemed abusive we receive a suspend + // signal. Suspend is a reason to put the project into an INTERNAL_OFF + // state. + // "REINSTATE" - Projects that were once considered abusive can later + // be deemed non-abusive. When this happens we must reinstate the + // project. Reinstate is a reason to put the project into an ON state. + Abuse string `json:"abuse,omitempty"` + + // Possible values: + // "BILLING_UNKNOWN_REASON" - An unknown reason indicates that the + // billing system has not sent a signal for this project. + // "BILLING_CONTROL_PLANE_SYNC" - Due to various reasons CCFE might + // proactively restate a project state to a CLH to ensure that the CLH + // and CCFE are both aware of the project state. This reason can be tied + // to any of the states. + // "PROBATION" - Minor infractions cause a probation signal to be + // sent. Probation is a reason to put the project into a ON state even + // though it is a negative signal. CCFE will block mutations for this + // project while it is on billing probation, but the CLH is expected to + // serve non-mutation requests. + // "CLOSE" - When a billing account is closed, it is a stronger signal + // about non-payment. Close is a reason to put the project into an + // INTERNAL_OFF state. + // "OPEN" - Consumers can re-open billing accounts and update accounts + // to pull them out of probation. When this happens, we get a signal + // that the account is open. Open is a reason to put the project into an + // ON state. + Billing string `json:"billing,omitempty"` + + // Possible values: + // "DATA_GOVERNANCE_UNKNOWN_REASON" - An unknown reason indicates that + // data governance has not sent a signal for this project. + // "DATA_GOVERNANCE_CONTROL_PLANE_SYNC" - Due to various reasons CCFE + // might proactively restate a project state to a CLH to ensure that the + // CLH and CCFE are both aware of the project state. This reason can be + // tied to any of the states. + // "HIDE" - When a project is deleted we retain some data for a period + // of time to allow the consumer to change their mind. Data governance + // sends a signal to hide the data when this occurs. Hide is a reason to + // put the project in an INTERNAL_OFF state. + // "UNHIDE" - The decision to un-delete a project can be made. When + // this happens data governance tells us to unhide any hidden data. + // Unhide is a reason to put the project in an ON state. + // "PURGE" - After a period of time data must be completely removed + // from our systems. When data governance sends a purge signal we need + // to remove data. Purge is a reason to put the project in a DELETED + // state. Purge is the only event that triggers a delete mutation. All + // other events have update semantics. + DataGovernance string `json:"dataGovernance,omitempty"` + + // Possible values: + // "SERVICE_MANAGEMENT_UNKNOWN_REASON" - An unknown reason indicates + // that we have not received a signal from service management about this + // project. Since projects are created by request of service management, + // this reason should never be set. + // "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC" - Due to various reasons + // CCFE might proactively restate a project state to a CLH to ensure + // that the CLH and CCFE are both aware of the project state. This + // reason can be tied to any of the states. + // "ACTIVATION" - When a customer activates an API CCFE notifies the + // CLH and sets the project to the ON state. + // "PREPARE_DEACTIVATION" - When a customer deactivates and API + // service management starts a two-step process to perform the + // deactivation. The first step is to prepare. Prepare is a reason to + // put the project in a EXTERNAL_OFF state. + // "ABORT_DEACTIVATION" - If the deactivation is cancelled, service + // managed needs to abort the deactivation. Abort is a reason to put the + // project in an ON state. + // "COMMIT_DEACTIVATION" - If the deactivation is followed through + // with, service management needs to finish deactivation. Commit is a + // reason to put the project in a DELETED state. + ServiceManagement string `json:"serviceManagement,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Abuse") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Abuse") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Reasons) MarshalJSON() ([]byte, error) { + type NoMethod Reasons + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // RepairApplicationRequest: Request message for // 'Applications.RepairApplication'. type RepairApplicationRequest struct { diff --git a/civicinfo/v2/civicinfo-api.json b/civicinfo/v2/civicinfo-api.json index 3f43bd4d4f6..c6defd7da4b 100644 --- a/civicinfo/v2/civicinfo-api.json +++ b/civicinfo/v2/civicinfo-api.json @@ -352,7 +352,7 @@ } } }, - "revision": "20221011", + "revision": "20221206", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { @@ -1638,7 +1638,7 @@ "e.g. single family dwelling, office building.", "e.g. suite, room, hallway, cubicle.", "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", - "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", "DEPRECATED", "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." diff --git a/civicinfo/v2/civicinfo-gen.go b/civicinfo/v2/civicinfo-gen.go index 2a79b8b113f..036430d7cb1 100644 --- a/civicinfo/v2/civicinfo-gen.go +++ b/civicinfo/v2/civicinfo-gen.go @@ -1476,8 +1476,10 @@ type GeocodingSummary struct { // for a user to meet a taxi, ridesharing vehicle, or general driver. // "typeRegulatedArea" - An area controlled in some way by an // authoritative source, such as a government-designated COVID - // containment zone. Features of this type should have one or more gcids - // corresponding to their specific regulation. + // containment zone or an area under government sanctions. Features of + // this type should have one or more gcids corresponding to their + // specific regulation, and client handling of these features may vary + // based on the type of regulation. // "typeLogicalBorder" - A grouping of TYPE_BORDER features ("border // segments"), which together represent a border between two features of // the same type. diff --git a/contactcenterinsights/v1/contactcenterinsights-api.json b/contactcenterinsights/v1/contactcenterinsights-api.json index 860e483885e..fa8814fb4e2 100644 --- a/contactcenterinsights/v1/contactcenterinsights-api.json +++ b/contactcenterinsights/v1/contactcenterinsights-api.json @@ -1356,7 +1356,7 @@ } } }, - "revision": "20221116", + "revision": "20221204", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -1368,6 +1368,10 @@ "description": "Output only. The result of the analysis, which is populated when the analysis finishes.", "readOnly": true }, + "annotatorSelector": { + "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", + "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." + }, "createTime": { "description": "Output only. The time at which the analysis was created, which occurs when the long-running operation completes.", "format": "google-datetime", @@ -1466,6 +1470,55 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1AnnotatorSelector": { + "description": "Selector of all available annotators and phrase matchers to run.", + "id": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", + "properties": { + "issueModels": { + "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", + "items": { + "type": "string" + }, + "type": "array" + }, + "phraseMatchers": { + "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", + "items": { + "type": "string" + }, + "type": "array" + }, + "runEntityAnnotator": { + "description": "Whether to run the entity annotator.", + "type": "boolean" + }, + "runIntentAnnotator": { + "description": "Whether to run the intent annotator.", + "type": "boolean" + }, + "runInterruptionAnnotator": { + "description": "Whether to run the interruption annotator.", + "type": "boolean" + }, + "runIssueModelAnnotator": { + "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", + "type": "boolean" + }, + "runPhraseMatcherAnnotator": { + "description": "Whether to run the active phrase matcher annotator(s).", + "type": "boolean" + }, + "runSentimentAnnotator": { + "description": "Whether to run the sentiment annotator.", + "type": "boolean" + }, + "runSilenceAnnotator": { + "description": "Whether to run the silence annotator.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1AnswerFeedback": { "description": "The feedback that the customer has about a certain answer in the conversation.", "id": "GoogleCloudContactcenterinsightsV1AnswerFeedback", @@ -1577,6 +1630,10 @@ "format": "float", "type": "number" }, + "annotatorSelector": { + "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", + "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." + }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" @@ -2071,6 +2128,11 @@ "description": "Metadata for a create analysis operation.", "id": "GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata", "properties": { + "annotatorSelector": { + "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", + "description": "Output only. The annotator selector used for the analysis (if any).", + "readOnly": true + }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, @@ -2715,6 +2777,12 @@ "$ref": "GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig", "description": "Configs for the input data that used to create the issue model." }, + "issueCount": { + "description": "Output only. Number of issues in this issue model.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" @@ -3217,6 +3285,10 @@ "description": "Default configuration when creating Analyses in Insights.", "id": "GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig", "properties": { + "annotatorSelector": { + "$ref": "GoogleCloudContactcenterinsightsV1AnnotatorSelector", + "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." + }, "runtimeIntegrationAnalysisPercentage": { "description": "Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].", "format": "double", @@ -3356,6 +3428,55 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector": { + "description": "Selector of all available annotators and phrase matchers to run.", + "id": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", + "properties": { + "issueModels": { + "description": "The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.", + "items": { + "type": "string" + }, + "type": "array" + }, + "phraseMatchers": { + "description": "The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}", + "items": { + "type": "string" + }, + "type": "array" + }, + "runEntityAnnotator": { + "description": "Whether to run the entity annotator.", + "type": "boolean" + }, + "runIntentAnnotator": { + "description": "Whether to run the intent annotator.", + "type": "boolean" + }, + "runInterruptionAnnotator": { + "description": "Whether to run the interruption annotator.", + "type": "boolean" + }, + "runIssueModelAnnotator": { + "description": "Whether to run the issue model annotator. A model should have already been deployed for this to take effect.", + "type": "boolean" + }, + "runPhraseMatcherAnnotator": { + "description": "Whether to run the active phrase matcher annotator(s).", + "type": "boolean" + }, + "runSentimentAnnotator": { + "description": "Whether to run the sentiment annotator.", + "type": "boolean" + }, + "runSilenceAnnotator": { + "description": "Whether to run the silence annotator.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata": { "description": "The metadata for a bulk analyze conversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata", @@ -3401,6 +3522,10 @@ "format": "float", "type": "number" }, + "annotatorSelector": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", + "description": "To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run." + }, "filter": { "description": "Required. Filter used to select the subset of conversations to analyze.", "type": "string" @@ -3433,6 +3558,11 @@ "description": "Metadata for a create analysis operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata", "properties": { + "annotatorSelector": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector", + "description": "Output only. The annotator selector used for the analysis (if any).", + "readOnly": true + }, "conversation": { "description": "Output only. The Conversation that this Analysis Operation belongs to.", "readOnly": true, @@ -3779,6 +3909,12 @@ "$ref": "GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig", "description": "Configs for the input data that used to create the issue model." }, + "issueCount": { + "description": "Output only. Number of issues in this issue model.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" diff --git a/contactcenterinsights/v1/contactcenterinsights-gen.go b/contactcenterinsights/v1/contactcenterinsights-gen.go index 7b3aa1fa06f..85b226abf55 100644 --- a/contactcenterinsights/v1/contactcenterinsights-gen.go +++ b/contactcenterinsights/v1/contactcenterinsights-gen.go @@ -260,6 +260,11 @@ type GoogleCloudContactcenterinsightsV1Analysis struct { // populated when the analysis finishes. AnalysisResult *GoogleCloudContactcenterinsightsV1AnalysisResult `json:"analysisResult,omitempty"` + // AnnotatorSelector: To select the annotators to run and the phrase + // matchers to use (if any). If not specified, all annotators will be + // run. + AnnotatorSelector *GoogleCloudContactcenterinsightsV1AnnotatorSelector `json:"annotatorSelector,omitempty"` + // CreateTime: Output only. The time at which the analysis was created, // which occurs when the long-running operation completes. CreateTime string `json:"createTime,omitempty"` @@ -416,6 +421,71 @@ func (s *GoogleCloudContactcenterinsightsV1AnnotationBoundary) MarshalJSON() ([] return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudContactcenterinsightsV1AnnotatorSelector: Selector of all +// available annotators and phrase matchers to run. +type GoogleCloudContactcenterinsightsV1AnnotatorSelector struct { + // IssueModels: The issue model to run. If not provided, the most + // recently deployed topic model will be used. The provided issue model + // will only be used for inference if the issue model is deployed and if + // run_issue_model_annotator is set to true. If more than one issue + // model is provided, only the first provided issue model will be used + // for inference. + IssueModels []string `json:"issueModels,omitempty"` + + // PhraseMatchers: The list of phrase matchers to run. If not provided, + // all active phrase matchers will be used. If inactive phrase matchers + // are provided, they will not be used. Phrase matchers will be run only + // if run_phrase_matcher_annotator is set to true. Format: + // projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher + // } + PhraseMatchers []string `json:"phraseMatchers,omitempty"` + + // RunEntityAnnotator: Whether to run the entity annotator. + RunEntityAnnotator bool `json:"runEntityAnnotator,omitempty"` + + // RunIntentAnnotator: Whether to run the intent annotator. + RunIntentAnnotator bool `json:"runIntentAnnotator,omitempty"` + + // RunInterruptionAnnotator: Whether to run the interruption annotator. + RunInterruptionAnnotator bool `json:"runInterruptionAnnotator,omitempty"` + + // RunIssueModelAnnotator: Whether to run the issue model annotator. A + // model should have already been deployed for this to take effect. + RunIssueModelAnnotator bool `json:"runIssueModelAnnotator,omitempty"` + + // RunPhraseMatcherAnnotator: Whether to run the active phrase matcher + // annotator(s). + RunPhraseMatcherAnnotator bool `json:"runPhraseMatcherAnnotator,omitempty"` + + // RunSentimentAnnotator: Whether to run the sentiment annotator. + RunSentimentAnnotator bool `json:"runSentimentAnnotator,omitempty"` + + // RunSilenceAnnotator: Whether to run the silence annotator. + RunSilenceAnnotator bool `json:"runSilenceAnnotator,omitempty"` + + // ForceSendFields is a list of field names (e.g. "IssueModels") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "IssueModels") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudContactcenterinsightsV1AnnotatorSelector) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudContactcenterinsightsV1AnnotatorSelector + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudContactcenterinsightsV1AnswerFeedback: The feedback that // the customer has about a certain answer in the conversation. type GoogleCloudContactcenterinsightsV1AnswerFeedback struct { @@ -582,6 +652,11 @@ type GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest struct { // analyze, between [0, 100]. AnalysisPercentage float64 `json:"analysisPercentage,omitempty"` + // AnnotatorSelector: To select the annotators to run and the phrase + // matchers to use (if any). If not specified, all annotators will be + // run. + AnnotatorSelector *GoogleCloudContactcenterinsightsV1AnnotatorSelector `json:"annotatorSelector,omitempty"` + // Filter: Required. Filter used to select the subset of conversations // to analyze. Filter string `json:"filter,omitempty"` @@ -1361,6 +1436,10 @@ func (s *GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegme // GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: // Metadata for a create analysis operation. type GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata struct { + // AnnotatorSelector: Output only. The annotator selector used for the + // analysis (if any). + AnnotatorSelector *GoogleCloudContactcenterinsightsV1AnnotatorSelector `json:"annotatorSelector,omitempty"` + // Conversation: Output only. The Conversation that this Analysis // Operation belongs to. Conversation string `json:"conversation,omitempty"` @@ -1371,20 +1450,21 @@ type GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata struct { // EndTime: Output only. The time the operation finished running. EndTime string `json:"endTime,omitempty"` - // ForceSendFields is a list of field names (e.g. "Conversation") to - // unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "AnnotatorSelector") + // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Conversation") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "AnnotatorSelector") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -2515,6 +2595,9 @@ type GoogleCloudContactcenterinsightsV1IssueModel struct { // issue model. InputDataConfig *GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig `json:"inputDataConfig,omitempty"` + // IssueCount: Output only. Number of issues in this issue model. + IssueCount int64 `json:"issueCount,omitempty,string"` + // Name: Immutable. The resource name of the issue model. Format: // projects/{project}/locations/{location}/issueModels/{issue_model} Name string `json:"name,omitempty"` @@ -3360,27 +3443,31 @@ func (s *GoogleCloudContactcenterinsightsV1Settings) MarshalJSON() ([]byte, erro // GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: Default // configuration when creating Analyses in Insights. type GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig struct { + // AnnotatorSelector: To select the annotators to run and the phrase + // matchers to use (if any). If not specified, all annotators will be + // run. + AnnotatorSelector *GoogleCloudContactcenterinsightsV1AnnotatorSelector `json:"annotatorSelector,omitempty"` + // RuntimeIntegrationAnalysisPercentage: Percentage of conversations // created using Dialogflow runtime integration to analyze // automatically, between [0, 100]. RuntimeIntegrationAnalysisPercentage float64 `json:"runtimeIntegrationAnalysisPercentage,omitempty"` - // ForceSendFields is a list of field names (e.g. - // "RuntimeIntegrationAnalysisPercentage") to unconditionally include in - // API requests. By default, fields with empty or default values are - // omitted from API requests. However, any non-pointer, non-interface - // field appearing in ForceSendFields will be sent to the server - // regardless of whether the field is empty or not. This may be used to - // include empty fields in Patch requests. + // ForceSendFields is a list of field names (e.g. "AnnotatorSelector") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. - // "RuntimeIntegrationAnalysisPercentage") to include in API requests - // with the JSON null value. By default, fields with empty values are - // omitted from API requests. However, any field with an empty value - // appearing in NullFields will be sent to the server as null. It is an - // error if a field in this list has a non-empty value. This may be used - // to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "AnnotatorSelector") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -3638,6 +3725,71 @@ func (s *GoogleCloudContactcenterinsightsV1View) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: Selector +// of all available annotators and phrase matchers to run. +type GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector struct { + // IssueModels: The issue model to run. If not provided, the most + // recently deployed topic model will be used. The provided issue model + // will only be used for inference if the issue model is deployed and if + // run_issue_model_annotator is set to true. If more than one issue + // model is provided, only the first provided issue model will be used + // for inference. + IssueModels []string `json:"issueModels,omitempty"` + + // PhraseMatchers: The list of phrase matchers to run. If not provided, + // all active phrase matchers will be used. If inactive phrase matchers + // are provided, they will not be used. Phrase matchers will be run only + // if run_phrase_matcher_annotator is set to true. Format: + // projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher + // } + PhraseMatchers []string `json:"phraseMatchers,omitempty"` + + // RunEntityAnnotator: Whether to run the entity annotator. + RunEntityAnnotator bool `json:"runEntityAnnotator,omitempty"` + + // RunIntentAnnotator: Whether to run the intent annotator. + RunIntentAnnotator bool `json:"runIntentAnnotator,omitempty"` + + // RunInterruptionAnnotator: Whether to run the interruption annotator. + RunInterruptionAnnotator bool `json:"runInterruptionAnnotator,omitempty"` + + // RunIssueModelAnnotator: Whether to run the issue model annotator. A + // model should have already been deployed for this to take effect. + RunIssueModelAnnotator bool `json:"runIssueModelAnnotator,omitempty"` + + // RunPhraseMatcherAnnotator: Whether to run the active phrase matcher + // annotator(s). + RunPhraseMatcherAnnotator bool `json:"runPhraseMatcherAnnotator,omitempty"` + + // RunSentimentAnnotator: Whether to run the sentiment annotator. + RunSentimentAnnotator bool `json:"runSentimentAnnotator,omitempty"` + + // RunSilenceAnnotator: Whether to run the silence annotator. + RunSilenceAnnotator bool `json:"runSilenceAnnotator,omitempty"` + + // ForceSendFields is a list of field names (e.g. "IssueModels") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "IssueModels") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetada // ta: The metadata for a bulk analyze conversations operation. type GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata struct { @@ -3695,6 +3847,11 @@ type GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest str // analyze, between [0, 100]. AnalysisPercentage float64 `json:"analysisPercentage,omitempty"` + // AnnotatorSelector: To select the annotators to run and the phrase + // matchers to use (if any). If not specified, all annotators will be + // run. + AnnotatorSelector *GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector `json:"annotatorSelector,omitempty"` + // Filter: Required. Filter used to select the subset of conversations // to analyze. Filter string `json:"filter,omitempty"` @@ -3776,6 +3933,10 @@ func (s *GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRespons // GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadat // a: Metadata for a create analysis operation. type GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata struct { + // AnnotatorSelector: Output only. The annotator selector used for the + // analysis (if any). + AnnotatorSelector *GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector `json:"annotatorSelector,omitempty"` + // Conversation: Output only. The Conversation that this Analysis // Operation belongs to. Conversation string `json:"conversation,omitempty"` @@ -3786,20 +3947,21 @@ type GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata str // EndTime: Output only. The time the operation finished running. EndTime string `json:"endTime,omitempty"` - // ForceSendFields is a list of field names (e.g. "Conversation") to - // unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "AnnotatorSelector") + // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Conversation") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "AnnotatorSelector") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -4343,6 +4505,9 @@ type GoogleCloudContactcenterinsightsV1alpha1IssueModel struct { // issue model. InputDataConfig *GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig `json:"inputDataConfig,omitempty"` + // IssueCount: Output only. Number of issues in this issue model. + IssueCount int64 `json:"issueCount,omitempty,string"` + // Name: Immutable. The resource name of the issue model. Format: // projects/{project}/locations/{location}/issueModels/{issue_model} Name string `json:"name,omitempty"` diff --git a/contentwarehouse/v1/contentwarehouse-api.json b/contentwarehouse/v1/contentwarehouse-api.json index 747ff7c0b32..0988c031bc6 100644 --- a/contentwarehouse/v1/contentwarehouse-api.json +++ b/contentwarehouse/v1/contentwarehouse-api.json @@ -749,6 +749,35 @@ } } }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "contentwarehouse.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "ruleSets": { "methods": { "create": { @@ -1046,7 +1075,7 @@ } } }, - "revision": "20221110", + "revision": "20221206", "rootUrl": "https://contentwarehouse.googleapis.com/", "schemas": { "AbuseiamAbuseType": { @@ -3494,7 +3523,13 @@ "VOICE_WEB_AFFINITY", "SKILLSSTACK_AFFINITY", "WHOSTORY_AFFINITY", - "PHOTOS_PARTNER_SHARING_EMAIL_ONLY" + "PHOTOS_PARTNER_SHARING_EMAIL_ONLY", + "MEMORIZE_AFFINITY", + "BETTANY_AFFINITY", + "BASECAMP_AFFINITY", + "DRIVE_SEARCH_FILTER_AFFINITY", + "CULTURE_EVENTS_CALENDAR_AFFINITY", + "DATABRIDGE_CONSOLE_AFFINITY" ], "enumDescriptions": [ "", @@ -3724,6 +3759,12 @@ "", "", "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -9289,6 +9330,7 @@ "APP_DATA_USAGE", "APP_DETAILS", "APP_SHORTCUT", + "APPS_NOTIFICATIONS", "APPS_STORAGE", "ASSISTANT_ACCOUNT", "ASSISTANT_FACE_MATCH", @@ -9302,6 +9344,7 @@ "BATTERY_PERCENTAGE", "BATTERY_PRESENT", "BATTERY_SAVER", + "BATTERY_SAVER_SCHEDULE", "BATTERY_SHARE", "BATTERY_USAGE", "BIOMETRIC", @@ -9315,6 +9358,8 @@ "CAMERA_DOUBLE_TWIST", "CAST", "COLOR_INVERSION", + "COLOR_CORRECTION", + "CONVERSATIONS", "CHARGING_SOUNDS_AND_VIBRATION", "CHARGING_STATE", "CONNECTED_DEVICES", @@ -9326,6 +9371,8 @@ "DATA_LIMIT_LEVEL", "DATA_WARNING", "DATA_WARNING_LEVEL", + "DEFAULT_ALARM_SOUND", + "DEFAULT_NOTIFICATION_SOUND", "DEFAULT_APPS", "DEVELOPER_OPTIONS", "DEVICE_NAME", @@ -9342,13 +9389,17 @@ "EMERGENCY_ALERTS", "EMERGENCY_INFORMATION", "ETHERNET_TETHERING", + "EXTRA_DIM", + "EXTREME_BATTERY_SAVER", "FACTORY_RESET", + "FIND_MY_DEVICE", "FLASHLIGHT", "FOCUS_MODE", "FONT_SIZE", "FREE_UP_SPACE", "GESTURES", "HAPTIC_FEEDBACK_VIBRATION", + "HARD_KEYBOARD", "HEADS_UP", "HIGH_REFRESH_RATE", "HOT_SPOT", @@ -9360,6 +9411,7 @@ "KEYBOARD_SHORTCUTS", "LIFT_CHECK_PHONE", "LOCATION", + "LOCATION_HISTORY", "LOCATION_BLUETOOTH_SCANNING", "LOCATION_WIFI_SCANNING", "LOCK_SCREEN", @@ -9373,6 +9425,7 @@ "MANIFY_TRIPLE_TAP", "MEDIA", "MEDIA_VOLUME", + "MICROPHONE_ACCESS", "MOBILE", "MOBILE_DATA", "MUSIC", @@ -9386,11 +9439,15 @@ "NOTIFICATION_BADGE", "NOTIFICATION_SOUND", "NOTIFICATION_ON_SCREEN", + "NOTIFICATION_HISTORY", "NOTIFY_FOR_PUBLIC_NETWORKS", "ONEHANDED_MODE", + "OS_VERSION", "PASSWORD", "PERMISSION_MANAGER", + "PERMISSION_USAGE", "PERSONALIZATION", + "PRINTING", "PHONE_NUMBER", "PICTURE_IN_PICTURE", "POINTER_SPEED", @@ -9404,16 +9461,20 @@ "SCREEN_LOCKING_SOUND", "SCREEN_MAGNIFICATION", "SCREEN_TIMEOUT", + "SCREEN_LOCK", + "SCREEN_SAVER", "SELECT_TO_SPEAK", "SET_TIME_AUTOMATICALLY", "SET_TIME_ZONE_AUTOMATICALLY", "SETTINGS", "SIM", + "SIM_MANAGER", "SPEECH_RATE", "STORAGE_USAGE", "SWIPE_FOR_NOTIFICATION", "SWITCH_ACCESS", "SYSTEM_UPDATE", + "SYSTEM_NAVIGATION", "TALKBACK_PASSWORDS", "TEXT_TO_SPEECH", "TIME_ZONE", @@ -9422,6 +9483,7 @@ "USB_TETHERING", "VERBOSE_TTS", "VIBRATE", + "VIBRATION", "VIBRATION_MODE", "VOICE", "VOLUME_LEVEL", @@ -9498,6 +9560,8 @@ "", "", "", + "Deprecated, use DEFAULT_ALARM_SOUND instead.", + "", "", "", "", @@ -9539,6 +9603,8 @@ "", "", "", + "", + "", "Cellular carrier (non-wifi) data usage statistics \u0026 settings for the device.", "Toggle to enable data use limit", "The mobile data use after which mobile data is automatically disabled.", @@ -9555,11 +9621,14 @@ "", "", "", + "", + "", "Special mode for using device hands-free while driving.", "Main emergency settings", "", "", "", + "Makes screen extra dark.", "", "", "", @@ -9567,10 +9636,13 @@ "", "", "", + "A page for device gestures", + "Deprecated, use VIBRATION instead.", "", "", "", - "", + "Toggle for internet sharing via WiFi.", + "Common settings page for internet sharing via various means.", "", "Show my IP address", "", @@ -9581,6 +9653,7 @@ "", "", "", + "Settings page for what is visible on the lock screen.", "", "", "Show my MAC address", @@ -9591,6 +9664,7 @@ "", "", "", + "Microphone Access is a toggleable setting that controls if Microphone usage is allowed at the system level or not. It is not the per-App Microphone permission page. https://screenshot.googleplex.com/4hrskftPSur7hHh", "Wireless internet settings, including WiFi, Cellular, etc.", "Setting to enable/disable cellular data connection being used on the device. https://screenshot.googleplex.com/jMSRtW3Aq4o", "", @@ -9602,11 +9676,15 @@ "", "", "", + "Deprecated, use DEFAULT_NOTIFICATION_SOUND instead.", "", "", "", "", "", + "Password manager", + "Shows permissions and allows add/remove allowed apps.", + "Shows usage of each permission by app.", "", "", "", @@ -9622,26 +9700,30 @@ "", "", "", + "Settings page for screen locking security methods.", "", "", "", "", "", + "Currently active/primary SIM.", "", "", "", "", "", "", + "Settings page for configuring how navigation between apps is done. Specifically android has choice between Buttons of Gestures mode.", "", "", "", "", "", "", - "Corresponds to \"Vibration \u0026 haptics\" toggle in the settings app. Reference: http://shortn/_wE1WCid2aM", - "", "", + "Deprecated, use VIBRATION instead.", + "Vibration master toggle - controls all vibration functions. Corresponds to \"Vibration \u0026 haptics\" toggle in the Android settings app.", + "Controls whether the ringer mode will be silent or will vibrate. Details in https://developer.android.com/reference/android/media/AudioManager#RINGER_MODE_VIBRATE Different from VIBRATION from above.", "", "", "", @@ -9651,6 +9733,7 @@ "", "", "", + "Duplicate, use HOT_SPOT instead", "Begin of NGA proto consistence", "", "", @@ -9666,7 +9749,7 @@ "", "", "", - "", + "Duplicate, use NIGHT_MODE instead", "", "", "", @@ -12230,9 +12313,14 @@ "type": "object" }, "AssistantApiLoggingOnlyData": { - "description": "Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 14", + "description": "Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 15", "id": "AssistantApiLoggingOnlyData", "properties": { + "accountIndex": { + "description": "The index of the account on the device. Useful when there are multiple accounts on a device such as distinguishing primary user data from secondary users. There is no guarantee that this is a stable number but is relatively stable in practice.", + "format": "int32", + "type": "integer" + }, "acpVersion": { "description": "A user-readable string describing the ACP version (go/acp-version) of the client app used by the user to originate the conversation.", "type": "string" @@ -13006,12 +13094,14 @@ "enum": [ "UNKNOWN_RENDERING_FORMAT", "CONCISE_TEXT", - "PROTO_LAYOUT" + "PROTO_LAYOUT", + "ELEMENTS" ], "enumDescriptions": [ "", "Concise Text go/concise-text-responses", - "Proto Layout, the layout for Proto Tiles go/prototiles" + "Proto Layout, the layout for Proto Tiles go/prototiles", + "Elements, the layout for xUIKit go/xuikit" ], "type": "string" }, @@ -15034,11 +15124,11 @@ "type": "boolean" }, "coloredChipBackgroundBorderSupported": { - "description": "Whether client supports suggestion chips with colored background/border.", + "description": "Whether client supports suggestion chips with colored background/border. Deprecated in favor of go/color-token-suggestion-chip.", "type": "boolean" }, "coloredChipTextSupported": { - "description": "Whether client supports suggestion chips with colored text. See design doc: http://go/opa-suggestions-ux-eng-design.", + "description": "Whether client supports suggestion chips with colored text. See design doc: http://go/opa-suggestions-ux-eng-design. Deprecated in favor of go/color-token-suggestion-chip.", "type": "boolean" }, "debugDataSupported": { @@ -16653,22 +16743,22 @@ "type": "string" }, "numAlternateNameFromFuzzyContactMatch": { - "description": "Number of alternate contact names from fuzzy contact match.", + "description": "Number of alternate contact names from fuzzy contact match. (Not suggest using it since it can change due to retrieval iteration)", "format": "float", "type": "number" }, "numAlternateNamesFromS3": { - "description": "Number of alternate contact names from S3_HYPOTHESES.", + "description": "Number of alternate contact names from S3_HYPOTHESES. (Not suggest using it since it can change due to retrieval iteration)", "format": "float", "type": "number" }, "numAlternativeNamesFromInterpretation": { - "description": "Number of alternate contact names from interpretation.", + "description": "Number of alternate contact names from interpretation. (Not suggest using it since it can change due to retrieval iteration)", "format": "float", "type": "number" }, "numCandidates": { - "description": "Number of contacts populated by the contact Grounding Provider.", + "description": "Number of contacts populated by the contact Grounding Provider. (Not suggest using it since it can change due to retrieval iteration)", "format": "float", "type": "number" }, @@ -17552,7 +17642,6 @@ "MOVIE", "PHOTO", "TV_SHOW_EPISODE", - "PODCAST_EPISODE", "MUSIC_GENRE", "AUDIO_BOOK", "CHAPTER", @@ -17566,7 +17655,9 @@ "TV_SHOW", "NEWS", "NARRATED_WEB", - "AUDIO_STORY" + "AUDIO_STORY", + "PODCAST_SERIES", + "PODCAST_EPISODE" ], "enumDescriptions": [ "", @@ -17588,11 +17679,12 @@ "", "", "", - "", "Representing a TV show which contains multiple TV seasons.", "", "", - "Representing a short audio story. go/tmas-design" + "Representing a short audio story. go/tmas-design", + "Represent different kinds of podcast content", + "" ], "type": "string" }, @@ -20396,7 +20488,7 @@ "type": "object" }, "CompositeDoc": { - "description": "Protocol record used for collecting together all information about a document. Please consult go/dme for two basic questions about `CompositeDoc`: - Where should I look up certain information (e.g: pagerank, language)? - What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field's size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 191", + "description": "Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: - Where should I look up certain information (e.g: pagerank, language)? - What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field's size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 191", "id": "CompositeDoc", "properties": { "ContentChecksum96": { @@ -22923,7 +23015,7 @@ "e.g. single family dwelling, office building.", "e.g. suite, room, hallway, cubicle.", "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", - "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", "DEPRECATED", "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." @@ -25799,6 +25891,9 @@ }, "type": "array" }, + "classifierVersion": { + "type": "string" + }, "taxonomy": { "description": "Either taxonomy will be set, using the enum above, or taxonomy_name will be set (if the taxonomy is not one of the ones in the enum) - never both", "enum": [ @@ -27425,6 +27520,23 @@ "price": { "$ref": "GeostorePriceRangeProto", "description": "Price of the item. There should be at most one price for any given currency." + }, + "priceFormat": { + "description": "Represents which price format is being used by this item, which determines the usage/meaning of the “price” field above. Optional – the default value is legal and safe (represents no price if the “price” field is unset).", + "enum": [ + "PRICE_FORMAT_DEFAULT", + "PRICE_FORMAT_VARIES" + ], + "enumDescriptions": [ + "Default price format which uses the PriceRangeProto (set or unset) in the \"price\" field above to represent a price interval, or lack thereof.", + "Value for a price which explicitly varies, i.e. it should show as “Price may vary\" or similar. If this is the price_format, contents of the \"price\" field will be ignored." + ], + "type": "string" + }, + "rankingHint": { + "description": "Numerical score which can be provided by data sources to indicate preferred item ordering. This is purely a hint – we are not required to followed it if we have a different order we think is better. Higher scores represent items that should be shown more prominently/earlier. Optional.", + "format": "float", + "type": "number" } }, "type": "object" @@ -27816,6 +27928,9 @@ "PROVIDER_GOOGLE_GEO_LDE", "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING", "PROVIDER_GOOGLE_UGC_AGGREGATION", + "PROVIDER_GOOGLE_3D_BASEMAP", + "PROVIDER_GOOGLE_MAPFACTS_PRIVACY", + "PROVIDER_GOOGLE_GT_ALF", "PROVIDER_GOOGLE_LOCALSEARCH", "PROVIDER_GOOGLE_TRANSIT", "PROVIDER_GOOGLE_GEOWIKI", @@ -28334,7 +28449,8 @@ "PROVIDER_MASTERCARD", "PROVIDER_VATTENFALL", "PROVIDER_VIETGIS", - "PROVIDER_UNITE" + "PROVIDER_UNITE", + "PROVIDER_NEOGY" ], "enumDescriptions": [ "ABSTRACT The root of all provider types. This should never be present on an actual feature, but can be useful when calling InCategory.", @@ -28351,7 +28467,7 @@ "", "ABSTRACT", "", - "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730AE", + "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730B1", "ABSTRACT", "", "", @@ -28520,6 +28636,9 @@ "", "", "", + "", + "", + "", "The next new \"Google\" provider entries should be placed above.", "UMBRELLA", "", @@ -29038,7 +29157,8 @@ "", "", "", - "Note: Next available value is 0x126E." + "", + "Note: Next available value is 0x126F." ], "type": "string" }, @@ -30161,6 +30281,7 @@ "UNKNOWN", "BOGUS", "PRIVATE", + "PRIVATE_MUST_PURGE", "SPAM", "UNSUPPORTED", "PENDING", @@ -30172,7 +30293,8 @@ "enumDescriptions": [ "Reason unknown or not captured by one of the other values.", "Bogus data - doesn't represent a real world geographic place or is just largely bad/incorrect data.", - "Considered \"private\" data and we're legally (or otherwise) obligated to remove it.", + "Considered \"private\" data. We do not want to display this data to users, but we allow it to remain in MapFacts indefinitely.", + "Considered \"private\" data, which has been or will soon be fully removed from MapFacts and related systems (other than feature id and existence metadata).", "Bad data that was intentionally/maliciously contributed.", "Not enough data to support the existence of the feature. Different from the BOGUS case in that there is no positive evidence that place is/was incorrect. NOTE: This removal reason can only be set/unset by PROVIDER_GOOGLE_LOCAL_ALCHEMY and PROVIDER_GOOGLE_OYSTER_AUTO_EDITS.", "Indicates that the existence of the place is yet to be justified.", @@ -31907,7 +32029,7 @@ "e.g. single family dwelling, office building.", "e.g. suite, room, hallway, cubicle.", "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", - "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", "DEPRECATED", "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." @@ -32618,6 +32740,9 @@ "PROVIDER_GOOGLE_GEO_LDE", "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING", "PROVIDER_GOOGLE_UGC_AGGREGATION", + "PROVIDER_GOOGLE_3D_BASEMAP", + "PROVIDER_GOOGLE_MAPFACTS_PRIVACY", + "PROVIDER_GOOGLE_GT_ALF", "PROVIDER_GOOGLE_LOCALSEARCH", "PROVIDER_GOOGLE_TRANSIT", "PROVIDER_GOOGLE_GEOWIKI", @@ -33136,7 +33261,8 @@ "PROVIDER_MASTERCARD", "PROVIDER_VATTENFALL", "PROVIDER_VIETGIS", - "PROVIDER_UNITE" + "PROVIDER_UNITE", + "PROVIDER_NEOGY" ], "enumDescriptions": [ "ABSTRACT The root of all provider types. This should never be present on an actual feature, but can be useful when calling InCategory.", @@ -33153,7 +33279,7 @@ "", "ABSTRACT", "", - "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730AE", + "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730B1", "ABSTRACT", "", "", @@ -33322,6 +33448,9 @@ "", "", "", + "", + "", + "", "The next new \"Google\" provider entries should be placed above.", "UMBRELLA", "", @@ -33840,7 +33969,8 @@ "", "", "", - "Note: Next available value is 0x126E." + "", + "Note: Next available value is 0x126F." ], "type": "string" } @@ -34753,6 +34883,9 @@ "PROVIDER_GOOGLE_GEO_LDE", "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING", "PROVIDER_GOOGLE_UGC_AGGREGATION", + "PROVIDER_GOOGLE_3D_BASEMAP", + "PROVIDER_GOOGLE_MAPFACTS_PRIVACY", + "PROVIDER_GOOGLE_GT_ALF", "PROVIDER_GOOGLE_LOCALSEARCH", "PROVIDER_GOOGLE_TRANSIT", "PROVIDER_GOOGLE_GEOWIKI", @@ -35271,7 +35404,8 @@ "PROVIDER_MASTERCARD", "PROVIDER_VATTENFALL", "PROVIDER_VIETGIS", - "PROVIDER_UNITE" + "PROVIDER_UNITE", + "PROVIDER_NEOGY" ], "enumDescriptions": [ "ABSTRACT The root of all provider types. This should never be present on an actual feature, but can be useful when calling InCategory.", @@ -35288,7 +35422,7 @@ "", "ABSTRACT", "", - "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730AE", + "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730B1", "ABSTRACT", "", "", @@ -35457,6 +35591,9 @@ "", "", "", + "", + "", + "", "The next new \"Google\" provider entries should be placed above.", "UMBRELLA", "", @@ -35975,7 +36112,8 @@ "", "", "", - "Note: Next available value is 0x126E." + "", + "Note: Next available value is 0x126F." ], "type": "string" }, @@ -36693,6 +36831,48 @@ }, "type": "object" }, + "GeostorePriceInfoSourceDetails": { + "id": "GeostorePriceInfoSourceDetails", + "properties": { + "lastUpdateSources": { + "items": { + "$ref": "GeostorePriceInfoSourceDetailsSourceData" + }, + "type": "array" + }, + "sourceData": { + "items": { + "$ref": "GeostorePriceInfoSourceDetailsSourceData" + }, + "type": "array" + } + }, + "type": "object" + }, + "GeostorePriceInfoSourceDetailsSourceData": { + "id": "GeostorePriceInfoSourceDetailsSourceData", + "properties": { + "clientProjectNumber": { + "description": "Project number of the GMB API client. Set only if the source is EXTERNAL_GMB_API.", + "format": "int64", + "type": "string" + }, + "source": { + "enum": [ + "SOURCE_UNSPECIFIED", + "NMX_UI", + "EXTERNAL_GMB_API" + ], + "enumDescriptions": [ + "No source specified.", + "The menu comes from our own UI.", + "The menu comes from a third party." + ], + "type": "string" + } + }, + "type": "object" + }, "GeostorePriceInfoStatus": { "description": "Providers of PriceInfo (e.g. SinglePlatform, YEXT) send verified and unverified listings. PriceInfoStatus is used to encapsulate this information.", "id": "GeostorePriceInfoStatus", @@ -36728,6 +36908,11 @@ "description": "A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section.", "id": "GeostorePriceListProto", "properties": { + "aggregatorId": { + "description": "For third party lists, represents the ID of the aggregator which provided this data. Optional.", + "format": "uint64", + "type": "string" + }, "availableTime": { "$ref": "GeostoreTimeScheduleProto", "description": "The time period when this price list is available. Establishments are not required to give available_time for any given price list, however, when this field is not set, the price list is understood as available any time the establishment is open." @@ -36821,6 +37006,10 @@ }, "type": "array" }, + "sourceDetails": { + "$ref": "GeostorePriceInfoSourceDetails", + "description": "Source of the information retrieved, could be from our own NMX UI or a third party API." + }, "sourceUrl": { "$ref": "GeostoreUrlListProto", "description": "Where this price list comes from. If set, this must also be a member of the price_list_url field, and represents translations of a single URL." @@ -36858,14 +37047,16 @@ "TYPE_FOOD", "TYPE_SERVICE", "TYPE_PRODUCT", - "TYPE_JOB" + "TYPE_JOB", + "TYPE_3P_JOB" ], "enumDescriptions": [ "Abstract type, and the root of all types. Not a meaningful type and likewise should never be present in a geostore repository.", "For food and drink items, stored in FoodMenuItemProto.", "For service items (stored in FoodMenuItemProto). TYPE_SERVICE is being deprecated. Please use TYPE_JOB for the new services See b/147253790 for more information. data.", "For product items (stored in ComposableItemProto).", - "For jobs (stored in ComposableItemProto)." + "For \"1P\" jobs data (stored in ComposableItemProto), summarized from a variety of sources such as GMB/NMX, web crawling, and Structured Reviews.", + "For third party jobs data sourced from 3P partner feeds, which need to remain separate from the TYPE_JOB list." ], "type": "string" }, @@ -37189,6 +37380,9 @@ "PROVIDER_GOOGLE_GEO_LDE", "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING", "PROVIDER_GOOGLE_UGC_AGGREGATION", + "PROVIDER_GOOGLE_3D_BASEMAP", + "PROVIDER_GOOGLE_MAPFACTS_PRIVACY", + "PROVIDER_GOOGLE_GT_ALF", "PROVIDER_GOOGLE_LOCALSEARCH", "PROVIDER_GOOGLE_TRANSIT", "PROVIDER_GOOGLE_GEOWIKI", @@ -37707,7 +37901,8 @@ "PROVIDER_MASTERCARD", "PROVIDER_VATTENFALL", "PROVIDER_VIETGIS", - "PROVIDER_UNITE" + "PROVIDER_UNITE", + "PROVIDER_NEOGY" ], "enumDescriptions": [ "ABSTRACT The root of all provider types. This should never be present on an actual feature, but can be useful when calling InCategory.", @@ -37724,7 +37919,7 @@ "", "ABSTRACT", "", - "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730AE", + "All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730B1", "ABSTRACT", "", "", @@ -37893,6 +38088,9 @@ "", "", "", + "", + "", + "", "The next new \"Google\" provider entries should be placed above.", "UMBRELLA", "", @@ -38411,7 +38609,8 @@ "", "", "", - "Note: Next available value is 0x126E." + "", + "Note: Next available value is 0x126F." ], "type": "string" } @@ -43681,7 +43880,7 @@ "type": "array" }, "query": { - "description": "The query string that matches against the full text of the document and the searchable properties. The maximum number of allowed characters is 255.", + "description": "The query string that matches against the full text of the document and the searchable properties. The query partially supports [Google AIP style syntax](https://google.aip.dev/160). Specifically, the query supports literals, logical operators, negation operators, comparison operators, and functions. Literals: A bare literal value (examples: \"42\", \"Hugo\") is a value to be matched against. It searches over the full text of the document and the searchable properties. Logical operators: \"AND\", \"and\", \"OR\", and \"or\" are binary logical operators (example: \"engineer OR developer\"). Negation operators: \"NOT\" and \"!\" are negation operators (example: \"NOT software\"). Comparison operators: support the binary comparison operators =, !=, \u003c, \u003e, \u003c= and \u003e= for string, numeric, enum, boolean. Also support like operator `~~` for string. It provides semantic search functionality by parsing, stemming and doing synonyms expansion against the input query. To specify a property in the query, the left hand side expression in the comparison must be the property ID including the parent. The right hand side must be literals. For example: \"\\\"projects/123/locations/us\\\".property_a \u003c 1\" matches results whose \"property_a\" is less than 1 in project 123 and us location. The literals and comparison expression can be connected in a single query (example: \"software engineer \\\"projects/123/locations/us\\\".salary \u003e 100\"). Functions: supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Support nested expressions connected using parenthesis and logical operators. The default logical operators is `AND` if there is no operators between expressions. The query can be used with other filters e.g. `time_filters` and `folder_name_filter`. They are connected with `AND` operator under the hood. The maximum number of allowed characters is 255.", "type": "string" }, "queryContext": { @@ -43757,7 +43956,7 @@ "type": "string" }, "displayName": { - "description": "Required. Name of the schema given by the user. Must be unique per customer.", + "description": "Required. Name of the schema given by the user. Must be unique per project.", "type": "string" }, "documentIsFolder": { @@ -44639,7 +44838,7 @@ "type": "integer" }, "orderBy": { - "description": "The criteria determining how search results are sorted. For non-empty query, default is `\"relevance desc\"`. For empty query, default is `\"upload_date desc\"`. Supported options are: * `\"relevance desc\"`: By relevance descending, as determined by the API algorithms. * `\"upload_date desc\"`: By upload date descending. * `\"upload_date\"`: By upload date ascending. * `\"update_date desc\"`: By last updated date descending. * `\"update_date\"`: By last updated date ascending.", + "description": "The criteria determining how search results are sorted. For non-empty query, default is `\"relevance desc\"`. For empty query, default is `\"upload_date desc\"`. Supported options are: * `\"relevance desc\"`: By relevance descending, as determined by the API algorithms. * `\"upload_date desc\"`: By upload date descending. * `\"upload_date\"`: By upload date ascending. * `\"update_date desc\"`: By last updated date descending. * `\"update_date\"`: By last updated date ascending. * `\"retrieval_importance desc\"`: By retrieval importance of properties descending. This feature is still under development, please do not use unless otherwise instructed to do so.", "type": "string" }, "pageSize": { @@ -45186,7 +45385,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1DocumentStyle" }, @@ -45289,7 +45488,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -45479,7 +45678,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -45599,7 +45798,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -46363,6 +46562,15 @@ "description": "The status indicating the user is temporarily busy and there is not a more specific status derived from calendar that applies (e.g., InMeeting or DoNotDisturb).", "id": "GoogleInternalAppsWaldoV1alphaCalendarBusy", "properties": { + "committedUntil": { + "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb, Busy or OutOfOffice \u003c Xh. Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh).", + "format": "google-datetime", + "type": "string" + }, + "committedUntilIsMixed": { + "description": "Whether the status of the user from this status's start to committed_until has more than one status type (e.g. DoNotDisturb + InMeeting).", + "type": "boolean" + }, "eventSummary": { "description": "The summary of the corresponding event in Calendar.", "type": "string" @@ -46404,7 +46612,7 @@ "id": "GoogleInternalAppsWaldoV1alphaDoNotDisturb", "properties": { "committedUntil": { - "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb or OutOfOffice \u003c Xh.", + "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb, Busy or OutOfOffice \u003c Xh.", "format": "google-datetime", "type": "string" }, @@ -46436,7 +46644,7 @@ "id": "GoogleInternalAppsWaldoV1alphaInMeeting", "properties": { "committedUntil": { - "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb or OutOfOffice \u003c Xh. Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh).", + "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb, Busy or OutOfOffice \u003c Xh. Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh).", "format": "google-datetime", "type": "string" }, @@ -46512,12 +46720,12 @@ "type": "string" }, "committedUntil": { - "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb or OutOfOffice \u003c Xh. Note that if this OOO block is large (\u003eXh), committed_until will be the end of this block, not including any meetings or focus time following it.", + "description": "The time when the user will stop being committed, i.e., when their status will be neither of InMeeting, DoNotDisturb, Busy or OutOfOffice \u003c Xh. Note that if this OOO block is large (\u003e=Xh), committed_until is not set.", "format": "google-datetime", "type": "string" }, "committedUntilIsMixed": { - "description": "Whether the status of the user from this status's start to committed_until has more than one status type (e.g. DoNotDisturb + InMeeting).", + "description": "Whether the status of the user from this status's start to committed_until has more than one status type (e.g. DoNotDisturb + InMeeting). Only set if committed_until is set.", "type": "boolean" }, "eventSummary": { @@ -46561,10 +46769,10 @@ "properties": { "nextCommitmentStatus": { "$ref": "GoogleInternalAppsWaldoV1alphaUserStatus", - "description": "The status type of the commitment above. The status will be an empty instance of the corresponding type, no additional data will be provided." + "description": "The status of the commitment above." }, "nextCommitmentTime": { - "description": "The most relevant upcoming commitment (InMeeting, DoNotDisturb or OutOfOffice). In most cases this will be the next closest commitment event, but if there is a large OOO in less than 24h it will take precedence over earlier events.", + "description": "The most relevant upcoming commitment (InMeeting, DoNotDisturb, CalendarBusy or OutOfOffice). This context is set only if there is an upcoming commitment to show, and only on non commitments. Priority is given to the next closest commitment if its start is close enough to this event, otherwise the next large OOO if there is one.", "format": "google-datetime", "type": "string" } @@ -48055,6 +48263,7 @@ "type": "integer" }, "requestHeader": { + "description": "Only necessary headers are recorded. See google3/htmlrender/webkit_headless/resource_key.cc", "items": { "$ref": "HtmlrenderWebkitHeadlessProtoReferencedResourceHttpHeader" }, @@ -48460,6 +48669,7 @@ "type": "string" }, "requestHeader": { + "description": "Only necessary headers are included in the resource key by default. See google3/htmlrender/webkit_headless/resource_key.cc", "items": { "$ref": "HtmlrenderWebkitHeadlessProtoResourceHttpHeader" }, @@ -49500,6 +49710,8 @@ "VPREVIEW_TYPE_VERTICAL_90K", "VPREVIEW_TYPE_540K_ORIGINAL_HQ_LICENSED", "VPREVIEW_TYPE_90K_SPORT_HIGHLIGHT", + "VPREVIEW_TYPE_VIDEO_ANSWER_300K_15SEC", + "VPREVIEW_TYPE_VIDEO_ANSWER_300K_6SEC", "VPREVIEW_TENOR_250K_PREVIEW", "VPREVIEW_TENOR_100K_OPTIMIZED_PREVIEW", "VPREVIEW_TENOR_30K_OPTIMIZED_THUMBNAIL_PREVIEW", @@ -49530,6 +49742,8 @@ "This corresponds to 216x384, 10fps.", "This corresponds to 854x480, 24fps. This preview type is used for LMS videos only.", "This corresponds to 384x216, 10fps previews created with a Sport Highlight specific model. LINT.ThenChange( //depot/google3/video/pipeline/graph/sequences/mp4_moving_thumbnail.go )", + "Video Answer previews (640x360, 10fps). See go/vsva-le1-doc and go/vsva-serving-design for the details. previews up to 15 seconds", + "previews up to 6 seconds", "LINT.IfChange Tenor VPREIVEW is added by cl/237845543 (billzeng) This corresponds to 498*498, max 18fps. Preview for Tenor only.", "This corresponds to 220*498, max 18fps. Preview for Tenor only.", "This corresponds to 498*60, max 18fps. Preview for Tenor only.", @@ -49549,7 +49763,7 @@ "This corresponds to 498*100, max 10fps. Preview for Tenor only.", "This corresponds to 498*200, max 10fps. Preview for Tenor only.", "This corresponds to 100*498, max 10fps. Preview for Tenor only.", - "This corresponds to 200*498, max 10fps. Preview for Tenor only. LINT.ThenChange( //depot/google3/image/tenor/eleven/util/format_helpers.cc, //depot/google3/image/tenor/eleven/util/format_helpers_test.cc, //depot/google3/image/tenor/ps1/plugin/data_processing/service/util/transcode_type_translator.cc:preview_type_map, )" + "This corresponds to 200*498, max 10fps. Preview for Tenor only. LINT.ThenChange( //depot/google3/image/tenor/eleven/util/format_helpers.cc, //depot/google3/image/tenor/eleven/util/format_helpers_test.cc, )" ], "type": "string" }, @@ -51421,7 +51635,8 @@ "GENUS_DEMO", "GENUS_KARTO", "GENUS_CONTRIB_SERVICE_SHARED", - "GENUS_CONTRIB_SERVICE_GEO_UGC" + "GENUS_CONTRIB_SERVICE_GEO_UGC", + "GENUS_SEARCH_SPORTS" ], "enumDescriptions": [ "", @@ -51467,7 +51682,8 @@ "Genus for new Video Processing clients to do initial prototyping before they decide to formally onboard. go/venom-clients#demo-tier", "Genus for Karto videos.", "Shared genus for ContribService UGC videos for small clients requesting the same set of common signals. Large ContribService Video clients should have their own genera. go/user-owned-video-content-processing", - "Genus for GEO UGC videos processed by ContribService. go/venom-lite-for-geo-photo-videos" + "Genus for GEO UGC videos processed by ContribService. go/venom-lite-for-geo-photo-videos", + "Genus for Search Sports vertical videos" ], "type": "string" }, @@ -52263,7 +52479,8 @@ "GENUS_DEMO", "GENUS_KARTO", "GENUS_CONTRIB_SERVICE_SHARED", - "GENUS_CONTRIB_SERVICE_GEO_UGC" + "GENUS_CONTRIB_SERVICE_GEO_UGC", + "GENUS_SEARCH_SPORTS" ], "enumDescriptions": [ "", @@ -52309,7 +52526,8 @@ "Genus for new Video Processing clients to do initial prototyping before they decide to formally onboard. go/venom-clients#demo-tier", "Genus for Karto videos.", "Shared genus for ContribService UGC videos for small clients requesting the same set of common signals. Large ContribService Video clients should have their own genera. go/user-owned-video-content-processing", - "Genus for GEO UGC videos processed by ContribService. go/venom-lite-for-geo-photo-videos" + "Genus for GEO UGC videos processed by ContribService. go/venom-lite-for-geo-photo-videos", + "Genus for Search Sports vertical videos" ], "type": "string" }, @@ -54356,6 +54574,9 @@ "$ref": "IndexingDocjoinerDataVersionVersionInfo" }, "chromeCounts": { + "$ref": "IndexingDocjoinerDataVersionVersionInfo" + }, + "instantNavboost": { "$ref": "IndexingDocjoinerDataVersionVersionInfo", "description": "LINT.ThenChange(//depot/google3/indexing/ames/spanner/schema/websearch_main.sdl)" }, @@ -58165,6 +58386,9 @@ "$ref": "NlpSemanticParsingAnnotationEvalData" }, "type": "array" + }, + "neuralLocationAnnotator": { + "$ref": "KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator" } }, "type": "object" @@ -58175,6 +58399,12 @@ "properties": {}, "type": "object" }, + "KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator": { + "description": "The value is used for CurrentQuery.annotator and PreviousQuery.annotator to indicate what annotator annotated the argument", + "id": "KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator", + "properties": {}, + "type": "object" + }, "KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery": { "description": "The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The \"person\" argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for \"Obama\", the \"person\" argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query.", "id": "KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery", @@ -58197,6 +58427,9 @@ "$ref": "EventIdMessage", "description": "The event ID of the query where this value was pulled from." }, + "neuralLocationAnnotator": { + "$ref": "KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator" + }, "role": { "$ref": "KnowledgeAnswersIntentQueryArgumentProvenancePreviousQueryRole" }, @@ -63110,9 +63343,13 @@ "type": "object" }, "MapsQualitySpecialWordsFlags": { - "description": "Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. -- Next available id: 21 --", + "description": "Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. -- Next available id: 22 --", "id": "MapsQualitySpecialWordsFlags", "properties": { + "isAlleyAffix": { + "description": "An affix that indicates an alley. Alleys are unnamed, numbered routes that are always linked to a \"parent street\". As these parent streets can be named e.g. \"7th street\" and alleys might be referred to as \"7th alley\", we need to be able to distinguish those affixes. For more details about alleys see go/vn-alley-geocoding.", + "type": "boolean" + }, "isCommonWord": { "description": "Common words E.g.: center, park, etc.", "type": "boolean" @@ -63946,144 +64183,6 @@ }, "type": "object" }, - "NewsReconServiceLrsQ2lrs2EntryPayload": { - "description": "Next ID: 7", - "id": "NewsReconServiceLrsQ2lrs2EntryPayload", - "properties": { - "isDailyMoment": { - "type": "boolean" - }, - "isMomentAnyFlavor": { - "description": "DEPRECATED as in: will be removed shortly.", - "type": "boolean" - }, - "isPlannedMoment": { - "type": "boolean" - }, - "lrsTypes": { - "description": "This is meant to hold `LongRunningStory.Type`s only, unfortunately adding an import here causes a circular dependency.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "momentRankingScore": { - "format": "int64", - "type": "string" - }, - "outKgFeatureTypes": { - "description": "LRS-level feature types to be sent as triples to KG. The equivalent KG collection will be added to the LRS topic.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "NewsReconServiceLrsQ2lrs2QueryToLrsDataset": { - "id": "NewsReconServiceLrsQ2lrs2QueryToLrsDataset", - "properties": { - "entries": { - "description": "At most one entry per (LRS, algo version) pair.", - "items": { - "$ref": "NewsReconServiceLrsQ2lrs2QueryToLrsEntry" - }, - "type": "array" - }, - "timeMillis": { - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "NewsReconServiceLrsQ2lrs2QueryToLrsEntry": { - "description": "Each entry is specific to one LRS, and contains all the information required for matching a query with the LRS. For example: entries { lrs { mid: \"/m/2024WakandaSenateElection\" } qref_entities { mid: \"/m/election\" # The general concept of election debug_index: 0 } qref_entities { mid: \"/m/senate\" debug_index: 1 } qref_entities { mid: \"/m/wakanda\" debug_index: 2 } qref_entities { mid: \"/m/WakandaSenate\" debug_index: 3 } qref_entities { mid: \"/m/2024\" # The year 2024 debug_index: 4 } patterns { pattern: \"TT***\" only_in { regions: \"WK\" # BCP-47 region code for Wakanda } } patterns { pattern: \"TTT**\" } patterns { pattern: \"T**T*\" } algo_version: 7 } The characters in every pattern string match the `qref_entities` pairwise. For example, in the pattern \"TT***\", the first T corresponds to the entity /m/election, the second T to /m/senate, the first star to /m/wakanda. A query matches a pattern if all the entities marked as T (== required) are found by QRef. If QRef also finds entities marked as star (== optional), those entities will be consumed in the LRS interpretation and added to the `QueryToLrsInterpretation.consumed_qref_mids` field. A query matches an entry if either: - QRef found the LRS entity itself in the query. This is the best-case scenario, it happens when the name of the event is well defined (for example \"brexit\") and the query mentions it explicitly; - the query matches any of the patterns defined in the entry. Next id: 8", - "id": "NewsReconServiceLrsQ2lrs2QueryToLrsEntry", - "properties": { - "algoVersion": { - "description": "The value of a `AlgoVersion.Enum` constant.", - "format": "int32", - "type": "integer" - }, - "entryIndex": { - "description": "Index of the entry in the list of entries. This does not need to be populated in the dataset which is written to disk.", - "format": "int32", - "type": "integer" - }, - "internalPayload": { - "$ref": "NewsReconServiceLrsQ2lrs2EntryPayload" - }, - "lrs": { - "$ref": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity" - }, - "patterns": { - "items": { - "$ref": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern" - }, - "type": "array" - }, - "qrefEntities": { - "items": { - "$ref": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity" - }, - "type": "array" - } - }, - "type": "object" - }, - "NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity": { - "description": "Next id: 7", - "id": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity", - "properties": { - "debugIndex": { - "format": "int32", - "type": "integer" - }, - "debugName": { - "type": "string" - }, - "encodedMid": { - "description": "This does not need to be populated in the dataset which is written to disk.", - "format": "uint64", - "type": "string" - }, - "mid": { - "type": "string" - } - }, - "type": "object" - }, - "NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict": { - "description": "A locale satisfies the restrict if there is any match.", - "id": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict", - "properties": { - "regions": { - "description": "BCP-47 region codes, e.g. \"US\". There is a match if the user's locale `.region_subtag()` is found in this set, e.g. the user's locale is \"es-US\".", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern": { - "id": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern", - "properties": { - "onlyIn": { - "$ref": "NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict", - "description": "If set, the pattern only applies if the locale satisifes the restrict." - }, - "pattern": { - "description": "A string containing N characters, where each character is 'T' (required) or '*' (optional), and N is the size of `qref_entities`. Characters match QRef entities pairwise.", - "type": "string" - } - }, - "type": "object" - }, "NlpLoggingQRewriteClientCallPathInfo": { "description": "The proto that holds the complete call path info of the QRewrite client (e.g. the QUS's phase like \"RBT\",\"QBT\"; the QUS's candidate type like \"Identity\"; and the ACE's candidate type like \"FuzzyMatcher\"). Next ID: 5 ACE tags", "id": "NlpLoggingQRewriteClientCallPathInfo", @@ -75983,6 +76082,11 @@ "GPAY_RELEASE_OPS", "SKILLSSTACK", "WHOSTORY", + "BETTANY", + "BASECAMP", + "CULTURE_EVENTS_CALENDAR", + "DATABRIDGE_CONSOLE", + "COMMSTAR", "DEPRECATED_QUICKSTART_FLUME", "DUO_CLIENT", "ALBERT", @@ -76405,7 +76509,7 @@ "Supply Chain Central http://go/scc-site Team contact: scc-infra@google.com", "Paisa app http://go/paisa Team contact: paisa-eng@google.com", "SandClock app http://go/sandclock Team contact: sandclock-eng@google.com", - "Account Settings Mobile http://go/asm Team contact: myaccount-mobile-eng@google.com", + "My Google Account http://go/my-google Team contact: my-google-eng@google.com", "The telephony application! Contact voice-team@ or voice-fe@", "Wing Marketplace http://go/xwma Team contact: wing-commerce-mobile-team@google.com", "Chime http://go/chime Team contact: chime-team@google.com", @@ -76611,6 +76715,11 @@ "Gpay Release Ops Team contact: gpay-release-ops@google.com", "Skillsstack Team contact:", "Whostory Team contact: whostory@google.com", + "Bettany Team contact: bettany-eng@google.com", + "Basecamp Team contact: hardware-ml-infra@google.com", + "CULTURE_EVENTS_CALENDAR Team contact: culture-events-calendar@google.com", + "Databridge Console Team contact: databrige-eng@google.com", + "Commstar Team contact: mdb.commstar-dev@google.com", "", "Duo Client Team contact: duo-eng@google.com", "Project albert (go/albert-frontend) Team contact: albert-eng@google.com", @@ -76877,7 +76986,7 @@ "type": "object" }, "PerDocData": { - "description": "=========================================================================== # Make sure you read the comments in the bottom before you add any new field. NB: As noted in the comments, this protocol buffer is used in both indexing and serving. In mustang serving implementations we only decode perdocdata during the search phase, and so this protocol should only contain data used during search. See mustang/repos_www/attachments.proto:{MustangBasicInfo,MustangContentInfo} for protocols used during search and/or docinfo. Next available tag deprecated, use this (and look for commented out fields): blaze-bin/net/proto_compiler/protocol-compiler --freetags \\ indexer/perdocdata/perdocdata.proto Next tag: 218", + "description": "=========================================================================== # Make sure you read the comments in the bottom before you add any new field. NB: As noted in the comments, this protocol buffer is used in both indexing and serving. In mustang serving implementations we only decode perdocdata during the search phase, and so this protocol should only contain data used during search. See mustang/repos_www/attachments.proto:{MustangBasicInfo,MustangContentInfo} for protocols used during search and/or docinfo. Next available tag deprecated, use this (and look for commented out fields): blaze-bin/net/proto_compiler/protocol-compiler --freetags \\ indexer/perdocdata/perdocdata.proto Next tag: 219", "id": "PerDocData", "properties": { "BlogData": { @@ -76988,10 +77097,6 @@ "format": "int32", "type": "integer" }, - "ScienceData": { - "$ref": "SciencePerDocData", - "description": "science data - used only in scholar index" - }, "SpamWordScore": { "description": "The spamword score is represented in 7-bits, going from 0 to 127.", "format": "int32", @@ -77356,6 +77461,10 @@ "$ref": "SpamMuppetjoinsMuppetSignals", "description": "Contains hacked site signals which will be used in query time joins. As of Oct'19, the field is stored in a separate corpus. It'll only be populated for in-flight requests between retrieve and full-score in perdocdata. So no extra storage is needed on muppet side." }, + "spambrainData": { + "$ref": "SpamBrainData", + "description": "Site level scores coming from spambrain." + }, "spambrainTotalDocSpamScore": { "description": "The document total spam score identified by spambrain, going from 0 to 1.", "format": "float", @@ -78283,7 +78392,7 @@ "e.g. single family dwelling, office building.", "e.g. suite, room, hallway, cubicle.", "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", - "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", "DEPRECATED", "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." @@ -82232,7 +82341,7 @@ "Sale - Time limited discount.", "Event - A time limited event available in the game or app.", "Crossover, also known as IP collaboration in JP - This is an event involving a collaboration IP.", - "Pre-registration update - announcement for pre-reg apps.", + "Pre-registration update - announcement for pre-reg apps. Note that this maps to a subtype of Major Update in the Play Console UI.", "Loyalty LiveOps event. E.g. special points earn promotion etc.", "First party promotions funded by Play.", "Sale events auto-generated by Play for apps on sale, rather than a sale event as declared through PDC.", @@ -82334,6 +82443,39 @@ }, "type": "object" }, + "QualityCalypsoAppsUniversalImage": { + "id": "QualityCalypsoAppsUniversalImage", + "properties": { + "fifeUrl": { + "type": "string" + }, + "height": { + "format": "int32", + "type": "integer" + }, + "width": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "QualityCalypsoAppsUniversalImageData": { + "id": "QualityCalypsoAppsUniversalImageData", + "properties": { + "featureGraphic": { + "$ref": "QualityCalypsoAppsUniversalImage", + "description": "aka. promotional image / cover image." + }, + "screenshot": { + "items": { + "$ref": "QualityCalypsoAppsUniversalImage" + }, + "type": "array" + } + }, + "type": "object" + }, "QualityCopiaFireflySiteSignal": { "description": "Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on \"//segindexer:compositedoc_proto\", we cannot make perdocdata contain it.", "id": "QualityCopiaFireflySiteSignal", @@ -84301,12 +84443,41 @@ "type": "object" }, "QualityNsrNsrDataMetadata": { - "description": "Contains meta information about this data.", + "description": "Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information.", "id": "QualityNsrNsrDataMetadata", "properties": { + "goldmineLookupKeyPerField": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "Same as raffia_lookup_key_per_field. Note that the goldmine_lookups have priority; if a field appears in both goldmine and raffia entries, it means it was taken from goldmine. If it's missing here but present in raffia_lookup_key_per_field, it was taken from raffia.", + "type": "object" + }, + "goldmineLookupKeys": { + "description": "The lookup keys attempted by goldmine. Note that goldmine only runs for urls which can be chunked differently than raffia; in those cases, goldmine related fields are empty.", + "items": { + "type": "string" + }, + "type": "array" + }, "raffiaLookupKey": { - "description": "This is an internal field set by Raffia, to indicate which lookup key this record belonged to. This is helpful in determining where the final data is coming from, as we don't populate `site_chunk` fields offline (at all), so we cannot distinguish if data is coming from host fallback, secondary chunks or something else.", "type": "string" + }, + "raffiaLookupKeyPerField": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "Returns the raffia lookup key per each field in the NsrData proto (with exclusion of the Metadata sub-message (i.e. this)). It contains information like 3 : 1, meaning that the field inside NsrData with id '3' (in this case 'host') has been taken by raffia from the raffia lookup key at index 1.", + "type": "object" + }, + "raffiaLookupKeys": { + "description": "This is an internal field set by Raffia, to indicate which lookup keys have been attempted to populate the NsrData for this document. This will allow us to determine which key has been used to populate each field in the proto. The keys are ordered by lookup priority; raffia will give priority to earlier keys, and only take fields from later keys if they are missing.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -88038,6 +88209,10 @@ "QualityTimebasedLastSignificantUpdate": { "id": "QualityTimebasedLastSignificantUpdate", "properties": { + "adjustmentInfo": { + "$ref": "QualityTimebasedLastSignificantUpdateAdjustments", + "description": "This is stored only for debugging purposes. Please consult dates@ team before making a dependency on this field." + }, "date": { "description": "LastSignificantUpdate as UNIX timestamp in seconds. This is the new signal (go/lsu-dd) from LSU Selector V2 (once that is enabled, see b/171879888 for status), falling back to the legacy V1 signal if the V2 signal does not exist. Please use the 'source' field to determine where the value comes from.", "format": "int64", @@ -88080,6 +88255,41 @@ }, "type": "object" }, + "QualityTimebasedLastSignificantUpdateAdjustments": { + "id": "QualityTimebasedLastSignificantUpdateAdjustments", + "properties": { + "adjustmentSource": { + "enum": [ + "UNSET", + "PASSAGE_TIMESTAMP", + "FIRSTSEEN", + "CONTENT_AGE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "isUpperboundTimestampPrecise": { + "description": "The timestamp is precise when it's derived from existing (\u003eMarch 2022) passage timestamp.", + "type": "boolean" + }, + "unadjustedTimestampInSeconds": { + "description": "The timestamp that was picked up by the component indicated in the LastSignificantUpdateSource but was dropped due to exceeding the upper bound. The two following fields are present only when the adjustment took place.", + "format": "int64", + "type": "string" + }, + "upperboundTimestampInSeconds": { + "description": "The upperbound value derived from passage timestamps. If present, the LSU date should never exceed this value. Design doc: go/lsu-max-passage-timestamp", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "QualityTimebasedOldnessInfo": { "id": "QualityTimebasedOldnessInfo", "properties": { @@ -89046,7 +89256,7 @@ "type": "object" }, "RepositoryAnnotationsRdfaRdfaRichSnippetsApplication": { - "description": "This structure holds data for application information for rich snippets Next ID: 51", + "description": "This structure holds data for application information for rich snippets Next ID: 52", "id": "RepositoryAnnotationsRdfaRdfaRichSnippetsApplication", "properties": { "appTypeData": { @@ -89126,6 +89336,10 @@ "iconUrlThumbnail": { "type": "string" }, + "imageData": { + "$ref": "QualityCalypsoAppsUniversalImageData", + "description": "Copied from google3/contentads/shared/boulder/mobile-app-data-image-data.proto." + }, "inAppPurchase": { "description": "Whether the app offers in-app purchase.", "type": "boolean" @@ -89229,6 +89443,7 @@ "type": "string" }, "screenUrlHref": { + "description": "TODO(b/260128276) deprecate this field in favor of image_data.", "items": { "type": "string" }, @@ -90779,9 +90994,6 @@ }, "type": "array" }, - "nameSignals": { - "$ref": "RepositoryWebrefPreprocessingNameSignals" - }, "refconNameInfo": { "description": "Contains names and names metadata used by Refcon.", "items": { @@ -92015,7 +92227,8 @@ "GENERIC_HONORIFIC", "NEGATIVE_SUPERLATIVE", "FACET_AUDIENCE", - "FACET_PURPOSE" + "FACET_PURPOSE", + "SUPERLATIVE" ], "enumDescriptions": [ "", @@ -92069,6 +92282,7 @@ "Non-specific Honorifc markers.", "", "Facets.", + "", "" ], "type": "string" @@ -92354,9 +92568,6 @@ }, "type": "array" }, - "queryToLongRunningStoryDataset": { - "$ref": "NewsReconServiceLrsQ2lrs2QueryToLrsDataset" - }, "resolutionPriority": { "description": "Undergoing migration into the PerVertical message. Avoid using it. Resolution priority for this entity. In case a query has many possible resolutions, only the ones with the highest resolution priority are annotated.", "format": "int32", @@ -92824,17 +93035,13 @@ "RATING_SOURCE_UNKNOWN", "RATING_SOURCE_EWOK", "RATING_SOURCE_SAFT_GOLDEN", - "RATING_SOURCE_CROWDCOMPUTE", - "RATING_SOURCE_CROWDCOMPUTE_RERATING", - "RATING_SOURCE_GOLDEN" + "RATING_SOURCE_CROWDCOMPUTE" ], "enumDescriptions": [ "", "", "", - "", - "", - "Ratings by WebRef engineers." + "" ], "type": "string" }, @@ -93098,18 +93305,6 @@ ], "type": "string" }, - "deprecatedItemId": { - "format": "int32", - "type": "integer" - }, - "deprecatedProjectId": { - "format": "int32", - "type": "integer" - }, - "deprecatedTaskId": { - "format": "int32", - "type": "integer" - }, "displayString": { "description": "How this rating is displayed in the evals, pre-computed from the other fields.", "type": "string" @@ -93118,16 +93313,10 @@ "description": "The url of the ewok task that resulted in this rating. Example: https://furball.corp.google.com/project/view-item?itemId=1\u0026projectId=2", "type": "string" }, - "itemDescription": { - "type": "string" - }, "itemId": { "format": "uint64", "type": "string" }, - "language": { - "type": "string" - }, "pageIsAboutChain": { "description": "If the topic is about a business chain, whether the", "enum": [ @@ -93148,11 +93337,8 @@ ], "type": "string" }, - "pageNotLoaded": { - "description": "If true, content_relevance is set to NONE.", - "type": "boolean" - }, "projectId": { + "description": "Metadata for task-level ratings. Not filled for aggregated doc-level ratings. ", "format": "uint64", "type": "string" }, @@ -93160,11 +93346,6 @@ "description": "Whether rater can understand the topic.", "type": "boolean" }, - "ratingScore": { - "description": "Floating point representation of the `content_relevant` field.", - "format": "double", - "type": "number" - }, "taskDetails": { "$ref": "RepositoryWebrefTaskDetails" }, @@ -93172,18 +93353,6 @@ "format": "uint64", "type": "string" }, - "taskStatus": { - "type": "string" - }, - "taskUser": { - "format": "int32", - "type": "integer" - }, - "templateId": { - "description": "Metadata for task-level ratings. Not filled for aggregated doc-level ratings. ", - "format": "int32", - "type": "integer" - }, "topicIsChain": { "description": "Whether the topic is about a business chain.", "enum": [ @@ -93214,33 +93383,18 @@ "format": "uint64", "type": "string" }, - "docLevelRating": { - "$ref": "RepositoryWebrefPerDocRelevanceRating" - }, "entityNameRating": { "items": { "$ref": "RepositoryWebrefEntityNameRatings" }, "type": "array" }, - "listMembership": { - "items": { - "$ref": "RepositoryWebrefToprefListMembership" - }, - "type": "array" - }, "mentionRating": { "items": { "$ref": "RepositoryWebrefMentionRatings" }, "type": "array" }, - "pageClassification": { - "items": { - "$ref": "RepositoryWebrefToprefPageClassification" - }, - "type": "array" - }, "taskLevelRating": { "items": { "$ref": "RepositoryWebrefPerDocRelevanceRating" @@ -93407,34 +93561,6 @@ }, "type": "object" }, - "RepositoryWebrefPreprocessingNameSignals": { - "description": "If you add any field, make sure to add it in reffresh to the empty checks at the end of the corresponding name extractor processors (extract-*-names.cc).", - "id": "RepositoryWebrefPreprocessingNameSignals", - "properties": { - "normalizedNameData": { - "description": "The set of name candidates and their signals for a given entity.", - "items": { - "$ref": "RepositoryWebrefPreprocessingNormalizedNameData" - }, - "type": "array" - } - }, - "type": "object" - }, - "RepositoryWebrefPreprocessingNameVariantData": { - "description": "Represents a single name with all its signal, like language, sources and confidences.", - "id": "RepositoryWebrefPreprocessingNameVariantData", - "properties": { - "variantSignals": { - "description": "Sources providing this name variant and their metadata. NOTE: by convention we only allow one proto per source.", - "items": { - "$ref": "RepositoryWebrefPreprocessingNameVariantSignals" - }, - "type": "array" - } - }, - "type": "object" - }, "RepositoryWebrefPreprocessingNameVariantSignals": { "description": "Next available tag: 33.", "id": "RepositoryWebrefPreprocessingNameVariantSignals", @@ -93452,17 +93578,10 @@ "KG_ALIAS", "KG_ISBN13", "KG_GTIN", - "KG_PRONUNCIATION", "KG_STOCK_TICKER", "KG_AVIATION", - "KG_CARS", - "KG_AWARDS", - "KG_WEBSITE_DERIVED_NAME", - "KG_BRACKET_STRIPPED_DERIVED_NAME", - "KG_LOCATION_DERIVED_NAME", "KG_TRUSTED_ALIAS", "KG_CHEMICAL_SYMBOL", - "KG_YEAR", "KG_RADIO_STATION", "KG_REVERSE_UNIQUE_PROPERTY", "KG_TRANSIT_STATION_CODE", @@ -93475,10 +93594,7 @@ "ENTITY_NAME_TRANSLATIONS_GENERATOR", "MAPFACTS", "MAPFACTS_PHONENUMBER", - "MAPFACTS_PERSON_NAME_GENERATOR", - "MAPFACTS_PERSON_FIRST_NAME_GENERATOR", "MAPFACTS_STREET_NAME_GENERATOR", - "MAPFACTS_SCORER", "MAPFACTS_FUZZY_PHONENUMBER", "MAPFACTS_NAME_GENERATOR", "MAPFACTS_GEOCODES_ADDRESS_LINES", @@ -93488,91 +93604,42 @@ "MAPFACTS_POSTAL_CODE_WITH_COUNTRY_CODE", "MAPFACTS_TRANSIT_LINE_NAME_GENERATOR", "MAPFACTS_HOUSE_ID", - "COOC", "CDOCS", "CDOCS_ANCHOR", "CDOCS_NAVBOOST", - "CDOCS_WIKIPEDIA", "CDOCS_REFERENCE_PAGE_URL", - "CDOCS_SCORER", - "CDOCS_REFERENCE_PAGE_URL_DERIVED", "WIKIJOINS", - "WIKIJOINS_NICKNAME", "WIKIDATA_AKA", "WIKIDATA_LABEL", - "WIKIJOIN_FRAGMENT_REDIRECT", - "WIKIJOIN_ALIAS", "PRODUCT", "PRODUCT_TITLE", - "PRODUCT_TITLE_VARIATION", - "PRODUCT_QUERY", - "PRODUCT_STRONG_IDENTIFIER", "PRODUCT_MANUFACTURER_PART_NUMBER", "PRODUCT_MODEL_VARIATION", - "PRODUCT_UNTRUSTED", "PRODUCT_COMPANY_OR_BRAND_STRIPPING", "PRODUCT_AGGRESSIVE_STRIP", "PRODUCT_AGGRESSIVE_BRAND_STRIP", - "PER_ENTITY_SCORE_AGGREGATOR", - "PER_ENTITY_SCORE_AGGREGATOR_ENTITY_KEYED", - "PER_ENTITY_SCORE_AGGREGATOR_NAME_KEYED", - "PER_ENTITY_SCORE_AGGREGATOR_FINAL", "SCORER", - "SCORER_BEST_NAME_PICKER", - "SCORER_COMMON_NGRAM_CONCEPT_BOOST", - "SCORER_LEGACY_COMMON_NGRAM_CONCEPT_BOOST", - "SCORER_SYNTACTIC_NAME_PROMOTION", "SCORER_CATEGORICAL_NAME_SUPPRESSOR", - "SCORER_TYPE_BASED_MULTIPLIER", - "SCORER_NAVINESS_GUARANTEE", - "SCORER_SINGLE_LETTER_NAME_DEMOTION", - "SCORER_TRUST_EXTRAPOLATION", - "SCORER_TRUST_DERIVATION", - "SCORER_AWARDS_VERTICAL", "SCORER_BAD_SUBNAME_DEMOTION", "SCORER_YEAR_NAME_DEMOTION", - "SCORER_ENTITY_NAME_RATIO", - "SCORER_COLLECTION_PATTERN", "SCORER_NAME_BLACKLIST", - "SCORER_TOKEN_CLUSTERING", - "SCORER_DEPRECATED_TOKEN_CLUSTERING", "NAME_LEAKAGE_PREVENTION", - "PER_ENTITY_NAME_LEAKAGE_PREVENTION", - "PER_NAME_NAME_LEAKAGE_PREVENTION", - "SPECIFICITY_COMPUTER", "INCOMPATIBLE_NUMBER_DEMOTION", "BAD_STRIPPED_NAME", "BAD_FRINGE_NAME", "BAD_PERSON_NAME", "PERSON_NAME_GENERATOR", "PERSON_NAME_GENERATOR_WITH_INITIALS", - "HEBREW_LOCATION_NAME_INFLECTOR", "INJECTED", - "INJECTED_SHOWTIMES_CHAIN", - "INJECTED_OLYMPICS", - "MINI_COOC", - "MORPHOLOGY", - "LYRICS_TRUSTED_NAME", - "NAME_ANNOTATION_PROCESSOR", - "COMPANY_DERIVED_NAME", "AFFIXED_NAME_GENERATOR", - "AFFIXED_NAME_GENERATOR_TRUSTED", - "BUSINESS_DERIVED_NAME", "BUSINESS_SUFFIX_STRIPPED_NAME", "CHAIN_NAME_GENERATOR", - "DEPRECATED_LOCATION_STRIPPED_NAME", "LOCATION_STRIPPED_NAME", - "LOCATION_STRIPPED_NAVBOOST_NAME", - "PARENT_NAME_GENERATOR", - "PROPAGATE_NAMES", "PUNCTUATION_STRIPPED_NAME", "LEXICON_GENERATOR", - "NAME_SYNONYMS", - "CURATED_NAME", "COMPOUND_NAME", "INDIC_NORMALIZER", "STRIP_FIRST_STOPWORD", - "CONJUNCTION_NORMALIZE", "MIX_CASE_NORMALIZE", "MOVIE_YEAR", "STRIP_IMPLICATION", @@ -93581,15 +93648,11 @@ "STRIP_WIKI", "CIVICS_NAME_GENERATOR", "STRIPPED_THEATER_NAME", - "TRANSLITERATION", "NUMBER_VARIANT_GENERATOR", "PERSONAL_MEDIA_NAME_GENERATOR", - "MRF_INDEXING_NAME", "MRF_INDEXING_NAME_TV_SHOWS", - "MATCH", "MATCH_WITH_MIDDLE_INITIALS", - "COMPOUND_RETRIEVAL_KEY", - "EVENT_RETRIEVAL_KEY" + "COMBINED" ], "enumDescriptions": [ "", @@ -93600,14 +93663,7 @@ "", "", "", - "", - "", - "", - "", - "", - "", - "KG aliases that were manually generated, such as car model years.", - "", + "KG aliases that were manually generated, e.g. SxEy names for TV episodes", "", "", "", @@ -93628,9 +93684,6 @@ "", "", "", - "", - "", - "", "Postal codes with a prefixed country code, e.g. I 39303, A 6604, CH 8005.", "", "", @@ -93641,22 +93694,6 @@ "", "", "", - "Reference page urls stripped of web prefixes.", - "", - "", - "", - "", - "", - "Aliases mined from Wikipedia pages, with sources such as infoboxes and bolded description text.", - "", - "", - "", - "", - "", - "", - "", - "", - "", "", "", "", @@ -93667,15 +93704,6 @@ "", "", "", - "", - "", - "", - "", - "", - "", - "", - "For the awards vertical for award categories we only trust names that come from structured data. This way we achieve our precision targets.", - "", "Scorer that checks and kills year-like names.", "", "", @@ -93685,34 +93713,9 @@ "", "", "", - "", - "", - "", - "", - "", - "", - "", - "", "This source is used for names injected in the name pipeline. This injection is a shortcut to get names in the model and should only be used as a temporary solution waiting to either put the names in KG or mine them directly in this pipeline.", "", "", - "Replaceability signals from mini cooc.", - "", - "Names considered trusted as they are found in lyrics.", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", "", "", "", @@ -93731,31 +93734,14 @@ "", "", "Names used for entity retrieval by MRF.", - "", - "Sources marking particular types of matches.", "Name is matched on middle initials.", - "A special key constructed as a combination of multiple items (mids, properties, etc.). Use cases include retrieval of compound entities based on components, potentially MDVC resolution in WebRef.", - "A special key for event retrieval." + "Source indicating a composition of signal sources." ], "type": "string" } }, "type": "object" }, - "RepositoryWebrefPreprocessingNormalizedNameData": { - "description": "Aggregation of all names of an entity that normalize to the same string.", - "id": "RepositoryWebrefPreprocessingNormalizedNameData", - "properties": { - "nameVariantData": { - "description": "Name variants and their signals by source. All these name variants normalize to @normalized_name given their locales. NOTE: This includes metadata aggregated for the normalized name.", - "items": { - "$ref": "RepositoryWebrefPreprocessingNameVariantData" - }, - "type": "array" - } - }, - "type": "object" - }, "RepositoryWebrefPreprocessingOriginalNames": { "id": "RepositoryWebrefPreprocessingOriginalNames", "properties": { @@ -94695,151 +94681,6 @@ }, "type": "object" }, - "RepositoryWebrefToprefListMembership": { - "description": "Entity-level classification. Template: experimental/topref/eval_entities/template.jhtml", - "id": "RepositoryWebrefToprefListMembership", - "properties": { - "member": { - "items": { - "$ref": "RepositoryWebrefToprefListMembershipListMember" - }, - "type": "array" - }, - "taskData": { - "$ref": "RepositoryWebrefTaskData" - } - }, - "type": "object" - }, - "RepositoryWebrefToprefListMembershipListMember": { - "id": "RepositoryWebrefToprefListMembershipListMember", - "properties": { - "id": { - "$ref": "RepositoryWebrefWebrefEntityId" - }, - "isMember": { - "enum": [ - "YES_NO_UNSURE_NONE", - "YES", - "NO", - "UNSURE" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "RepositoryWebrefToprefPageClassification": { - "description": "Top-level page classification. Template: experimental/topref/eval_main/template.jhtml", - "id": "RepositoryWebrefToprefPageClassification", - "properties": { - "isList": { - "enum": [ - "YES_NO_UNSURE_NONE", - "YES", - "NO", - "UNSURE" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "isListTypeCorrect": { - "enum": [ - "YES_NO_UNSURE_NONE", - "YES", - "NO", - "UNSURE" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "isRanking": { - "enum": [ - "YES_NO_UNSURE_NONE", - "YES", - "NO", - "UNSURE" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "isToplist": { - "enum": [ - "YES_NO_UNSURE_NONE", - "YES", - "NO", - "UNSURE" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "listType": { - "description": "A string generated based on the main collection of the list. E.g., /collection/geo/restaurant =\u003e \"Restaurants\" retrieved by following the /base/schemastaging/context_name/plural in KG.", - "type": "string" - }, - "ratedTitle": { - "description": "\"repeated\" because we potentially evaluate several (up to 5) title candidates for the page.", - "items": { - "$ref": "RepositoryWebrefToprefPageClassificationRatedTitle" - }, - "type": "array" - }, - "taskData": { - "$ref": "RepositoryWebrefTaskData" - } - }, - "type": "object" - }, - "RepositoryWebrefToprefPageClassificationRatedTitle": { - "id": "RepositoryWebrefToprefPageClassificationRatedTitle", - "properties": { - "isGood": { - "enum": [ - "YES_NO_UNSURE_NONE", - "YES", - "NO", - "UNSURE" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" - }, - "title": { - "type": "string" - } - }, - "type": "object" - }, "RepositoryWebrefTripleAnnotation": { "id": "RepositoryWebrefTripleAnnotation", "properties": { @@ -95738,7 +95579,7 @@ "e.g. single family dwelling, office building.", "e.g. suite, room, hallway, cubicle.", "A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", - "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.", + "An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", "A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", "DEPRECATED", "A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." @@ -97681,12 +97522,14 @@ "enum": [ "UNKNOWN", "RAFFIA_PROXY_SERVICE", - "SPORE_DUMP" + "SPORE_DUMP", + "INFERRED" ], "enumDescriptions": [ "", "Fetched through Raffia proxy service (go/raffia-proxy).", - "Fetched through the data dump by Spore team, aka '/namespace/custom_corpus/prod/clients/tpkit/science_search/export-spore/ttl=3d/...'" + "Fetched through the data dump by Spore team, aka '/namespace/custom_corpus/prod/clients/tpkit/science_search/export-spore/ttl=3d/...'", + "Inferred using ML" ], "type": "string" }, @@ -97782,12 +97625,14 @@ "enum": [ "UNKNOWN", "FIELD_OF_STUDY", - "GEO" + "GEO", + "ORGANIZATION" ], "enumDescriptions": [ "", "/collection/field_of_studies in KG.", - "/collection/geo/* in KG." + "/collection/geo/* in KG.", + "/collection/organization/* in KG" ], "type": "string" }, @@ -97995,77 +97840,6 @@ }, "type": "object" }, - "ScholarCitationPredictionSignal": { - "description": "An input into the citation prediction model.", - "id": "ScholarCitationPredictionSignal", - "properties": { - "metricType": { - "enum": [ - "METRIC_TYPE_NONE", - "METRIC_TYPE_MEAN", - "METRIC_TYPE_MEDIAN", - "METRIC_TYPE_20_80" - ], - "enumDescriptions": [ - "", - "", - "", - "Average of 20th and 80th percentiles." - ], - "type": "string" - }, - "signalType": { - "enum": [ - "SIGNAL_UNKNOWN", - "SIGNAL_NUM_FORWARD_LINKS", - "SIGNAL_ANY_PUBLICATION", - "SIGNAL_PUBORG", - "SIGNAL_AUTHOR_EMAIL_DOMAIN", - "SIGNAL_AUTHOR_DOC_LENGTH", - "SIGNAL_AUTHOR_TITLE_NGRAM", - "SIGNAL_VENUE_DOC_LENGTH", - "SIGNAL_VENUE_TITLE_NGRAM", - "SIGNAL_ANY_PUBLICATION_AUTHOR", - "SIGNAL_ANY_PUBLICATION_DOC_LENGTH", - "SIGNAL_ANY_PUBLICATION_TITLE_NGRAM", - "SIGNAL_PUBORG_DOC_LENGTH", - "SIGNAL_HOST_NAME_TITLE_NGRAM", - "SIGNAL_TOTAL_CITATIONS", - "SIGNAL_LAST_YEAR_CITATIONS", - "SIGNAL_2_YEARS_AGO_CITATIONS", - "SIGNAL_CITATIONS_PER_YEAR", - "SIGNAL_YEARS_WITH_NO_CITATION" - ], - "enumDescriptions": [ - "", - "Single fields.", - "", - "", - "", - "Pairs.", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], - "type": "string" - }, - "value": { - "format": "float", - "type": "number" - } - }, - "type": "object" - }, "ScienceCitation": { "id": "ScienceCitation", "properties": { @@ -98180,6 +97954,17 @@ "description": "DEPRECATED: use CitationSource", "type": "string" }, + "ClearedReason": { + "enum": [ + "CLEARED_REASON_NONE", + "CLEARED_REASON_TOC" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "ClusterDiscoveryDate": { "description": "Used for logging, recommendations, and sort-by-date. Contains the earliest discovery date of the cluster, adjusted for earlier publication dates. Stored in Universal time scale (100 ns ticks since 0001 AD) because Unix timestamp would lead to negative dates for pre-1970 docs.", "format": "int64", @@ -99286,325 +99071,164 @@ }, "type": "object" }, - "SciencePerDocData": { - "description": "Next tag: 43", - "id": "SciencePerDocData", + "SdrEmbedding": { + "id": "SdrEmbedding", "properties": { - "AbstractEndPosition": { - "description": "The first hit position after the end of the abstract. We index the abstract immediately after the body, so all hits between BodyEndPosition and AbstractEndPosition are from the abstract.", - "format": "int32", - "type": "integer" - }, - "BodyEndPosition": { - "description": "The first hit position past the last body hit.", - "format": "int32", - "type": "integer" - }, - "CitationPredictionSignal": { - "description": "Input features used to compute PredictedCitations.", + "values": { "items": { - "$ref": "ScholarCitationPredictionSignal" + "format": "float", + "type": "number" }, "type": "array" }, - "CourtLevel": { - "description": "Used for sorting legal documents by court; e.g. Supreme Court \u003e Appeals Court \u003e Trial Court", - "format": "int32", - "type": "integer" - }, - "DEPRECATEDCrawlTime": { - "format": "int64", - "type": "string" - }, - "DiscoveryAgeInDays": { - "description": "The age in days since discovery date at the time of indexing. Used to compute PredictedCitations.", + "version": { "format": "int32", "type": "integer" - }, - "DiscoveryTimestamp": { - "description": "Used for sorting articles by date, and as an input for recent-query ranking. Stored in Universal time scale (100 ns ticks since 0001 AD).", - "format": "int64", - "type": "string" - }, - "IsCitationOnly": { - "description": "citation-only marker - for use in scorer", - "type": "boolean" - }, - "NonScholarlinessPenalty": { - "description": "Scoring penalty for non-scholarly articles. In the range [0, 1], with 0 being no penalty and 1 being the full penalty.", + } + }, + "type": "object" + }, + "SdrPageAnchorsDocInfo": { + "id": "SdrPageAnchorsDocInfo", + "properties": { + "articleness": { "format": "float", "type": "number" }, - "NumBackwardLinks": { - "description": "Summary statistics, for display in the FE.", - "format": "int32", - "type": "integer" - }, - "NumRelated": { - "format": "int32", - "type": "integer" - }, - "NumTitleWords": { - "description": "Used for exact title boost in Scholar, as of 1/7/2008.", - "format": "int32", - "type": "integer" - }, - "NumVersions": { - "format": "int32", - "type": "integer" + "pageAnchors": { + "items": { + "$ref": "SdrPageAnchorsSitelink" + }, + "type": "array" }, - "OffDomAnchors": { - "format": "int32", - "type": "integer" + "qscore": { + "format": "float", + "type": "number" }, - "OnSiteAnchors": { - "format": "int32", - "type": "integer" + "sitelinkWrapper": { + "items": { + "$ref": "SdrPageAnchorsSitelinkWrapper" + }, + "type": "array" }, - "PredictedCitations": { - "description": "The predicted new citations for this document once it reaches 5 years after its discovery date. Not set for: - Documents 5 years or older - Citation only documents - Patents and legal documents", + "textRichness": { "format": "float", "type": "number" + } + }, + "type": "object" + }, + "SdrPageAnchorsSitelink": { + "id": "SdrPageAnchorsSitelink", + "properties": { + "embedding": { + "$ref": "SdrEmbedding", + "description": "Needed for relevance scoring." }, - "PredictedCitationsNext5Years": { - "description": "The predicted new citations for this document over the next 5 years. This differs from the PredictedCitations field in that this is set for documents of all ages, whereas PredictedCitations is only set for new documents. This is also a prediction over a fixed time interval, whereas the time interval for PredictedCitations depends on the document's age.", + "geometryScore": { + "description": "aggregate score from Section Geometry.", "format": "float", "type": "number" }, - "PublicationDay": { - "format": "int32", - "type": "integer" + "headingAbbrvScore": { + "description": "Heading Abbreviation score.", + "format": "float", + "type": "number" }, - "PublicationMonth": { - "format": "int32", - "type": "integer" + "hpScore": { + "description": "Needed for heading/passage filtering.", + "format": "float", + "type": "number" }, - "PublicationYear": { - "description": "Publication date. Used both for ranking of recent articles and for display in the FE.", + "level": { "format": "int32", "type": "integer" }, - "ScholarId": { - "description": "For links from websearch to scholar.", - "format": "uint64", - "type": "string" + "scrollTo": { + "$ref": "SdrScrollTo" }, - "Subject": { - "description": "DEPRECATED e.g., fp(\"med\")", - "format": "uint32", - "type": "integer" - }, - "TitleNgrams": { - "description": "A string encoding the uni-, bi-, and trigram weights in the title. This is encoded and decoded by science_search/util/title_ngrams.h.", - "format": "byte", - "type": "string" - }, - "TotalAnchors": { - "description": "Anchor count info for scorer", + "sectionHeight": { + "description": "Needed for Geometry Scoring and backoffs. from Section Geometry.", "format": "int32", "type": "integer" }, - "Type": { - "description": "The type of the article - paper, review, patent, etc.", - "enum": [ - "FIRST_ARTICLE_TYPE", - "PAPER", - "BOOK", - "BOOKLET", - "CONFERENCE", - "INBOOK", - "INCOLLECTION", - "MANUAL", - "MS_THESIS", - "MISC", - "PHD_THESIS", - "TECHREPORT", - "UNPUBLISHED", - "PATENT", - "WEB_SITE", - "BS_THESIS", - "REVIEW_ARTICLE", - "JOURNAL", - "LEGAL_DOC", - "BIBLIOGRAPHY", - "BOOK_REVIEW", - "RETRACTION", - "EDITORIAL", - "ART_PERF_REVIEW", - "POETRY", - "FICTION", - "NEWS", - "BIOGRAPHICAL", - "LEGISLATION", - "REFERENCE_MATERIAL", - "STANDARD", - "META_ANALYSIS", - "RANDOMIZED_TRIAL", - "NUM_ARTICLE_TYPES" - ], - "enumDescriptions": [ - "", - "", - "", - "unused; ", - "synonym for PAPER; ", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "entire journal, not an article", - "", - "", - "", - "For tracking", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], + "text": { + "description": "Heading/Reformulated text is needed to display.", "type": "string" - }, - "author": { - "items": { - "$ref": "SciencePerDocDataAuthor" - }, - "type": "array" - }, - "referencediscussion": { - "items": { - "$ref": "SciencePerDocDataReferenceDiscussion" - }, - "type": "array" - }, - "section": { - "description": "Section markers, sorted by begin_position, no overlapping.", - "items": { - "$ref": "SciencePerDocDataSection" - }, - "type": "array" - }, - "signal": { - "items": { - "$ref": "SciencePerDocDataSignal" - }, - "type": "array" } }, "type": "object" }, - "SciencePerDocDataAuthor": { - "description": "Used for exact author boost and for display in the FE.", - "id": "SciencePerDocDataAuthor", + "SdrPageAnchorsSitelinkWrapper": { + "description": "This wrapper is used for passing in additional information to generate embeddings in Goldmine.", + "id": "SdrPageAnchorsSitelinkWrapper", "properties": { - "IsCJK": { - "type": "boolean" + "abbreviatedHeadingText": { + "type": "string" }, - "LastName": { + "abbrvEmbedding": { + "$ref": "SdrEmbedding" + }, + "headingEmbedding": { + "$ref": "SdrEmbedding" + }, + "normalizedHeadingText": { "type": "string" }, - "OtherNames": { + "passageEmbedding": { + "$ref": "SdrEmbedding" + }, + "passageText": { "type": "string" } }, "type": "object" }, - "SciencePerDocDataReferenceDiscussion": { - "id": "SciencePerDocDataReferenceDiscussion", + "SdrScrollTo": { + "description": "Data needed to construct a go/scroll-to text fragment. The url fragment is: #:~:text=[prefix-,]text_start,text_end", + "id": "SdrScrollTo", "properties": { - "Level": { - "format": "int32", - "type": "integer" + "onpageMatches": { + "$ref": "SdrScrollToOnPageMatches" }, - "TargetID": { - "format": "uint64", + "prefix": { + "description": "Prefix to help with disambiguating between multiple text matches on page. Optional.", "type": "string" - } - }, - "type": "object" - }, - "SciencePerDocDataSection": { - "id": "SciencePerDocDataSection", - "properties": { - "beginPosition": { - "description": "The first hit position at the start of the section.", - "format": "int32", - "type": "integer" }, - "numPositions": { - "description": "Delta in hit position from the start of the section to the end.", - "format": "int32", - "type": "integer" + "suffix": { + "description": "Suffix to help with disambiguating between multiple text matches on page. Optional.", + "type": "string" }, - "type": { - "enum": [ - "UNKNOWN", - "REFERENCE" - ], - "enumDescriptions": [ - "", - "" - ], + "textEnd": { + "description": "End of the text span to be highlighted. Optional.", + "type": "string" + }, + "textStart": { + "description": "Start of the text span to be highlighted.", "type": "string" } }, "type": "object" }, - "SciencePerDocDataSignal": { - "id": "SciencePerDocDataSignal", + "SdrScrollToOnPageMatches": { + "description": "Number of matches in the page when using text alone, prefix + text, text + suffix, and prefix + text + suffix. The match is case-insensitive to align with go/scroll-to behavior.", + "id": "SdrScrollToOnPageMatches", "properties": { - "avgCitations": { - "description": "Values for different metrics", - "format": "float", - "type": "number" - }, - "count": { - "description": "Number of papers in the bucket for this paper/signal combination 16-bit value", - "format": "int32", - "type": "integer" - }, - "geThres1Count": { - "description": "Count of papers with 10 or more citations (ge is \u003e=) 16-bit value", + "text": { "format": "int32", "type": "integer" }, - "geThres2Count": { - "description": "Count of papers with 50 or more citations 16-bit value", + "textWithPrefix": { "format": "int32", "type": "integer" }, - "index": { - "description": "Signal type dependent (for Journals refers to the year) index must refers to years ago not absolute year. 8-bit value", + "textWithPrefixSuffix": { "format": "int32", "type": "integer" }, - "medianCitations": { - "format": "float", - "type": "number" - }, - "type": { + "textWithSuffix": { "format": "int32", "type": "integer" - }, - "weight": { - "description": "Authors own a part of a paper value. This is the cumulative weight. If all papers falling into this bucket are single author papers, then weight will be equal to 1.0. Otherwise it will be smaller.", - "format": "float", - "type": "number" } }, "type": "object" @@ -100644,6 +100268,10 @@ }, "type": "array" }, + "pageAnchorsDocInfo": { + "$ref": "SdrPageAnchorsDocInfo", + "description": "This field is populated in the Sitemap MDU subpopulator from cdoc data. This is used to store page anchors information for TopicTagsScrolltoFlow." + }, "searchInSite": { "description": "Enable site search.", "type": "boolean" @@ -101040,6 +100668,9 @@ "description": "Log model name, partition and input processor used to generate SnippetsBrain scores, if SnippetsBrain debugging is enabled.", "id": "SnippetExtraInfoSnippetsBrainModelInfo", "properties": { + "ng3ModelName": { + "type": "string" + }, "snippetsbrainModelName": { "description": "The below fields are populated by SnippetFlow in superroot.", "type": "string" @@ -101670,11 +101301,15 @@ "source": { "enum": [ "DISPLAY_NAME_SOURCE_UNSPECIFIED", - "LIMITED_PROFILE" + "LIMITED_PROFILE", + "LIMITED_PROFILE_FULL_NAME", + "LIMITED_PROFILE_SHORTENED_NAME" ], "enumDescriptions": [ "", - "" + "DEPRECATED(b/248135053): in favor of `LIMITED_PROFILE_FULL_NAME`, and `LIMITED_PROFILE_SHORTENED_NAME`", + "The source is the limited profile, and the full name is visible.", + "The source is the limited profile, and it's a shortened name." ], "type": "string" } @@ -101817,7 +101452,7 @@ "id": "SocialGraphApiProtoMonthlyWeekdayRecurrence", "properties": { "weekDay": { - "description": "The nth occurrence of week_day to match. I.e. For 3rd Wednesday of the month, week_day = WEDNESDAY and week_day_number = 3. Values beyond the end of the month are skipped. Negative values are relative from end of month (e.g. Last Friday of every month).", + "description": "The nth occurrence of week_day to match. I.e. For 3rd Wednesday of the month, week_day = WEDNESDAY and week_day_number = 3. Values beyond the end of the month are skipped.", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", @@ -102153,14 +101788,14 @@ "type": "object" }, "SocialGraphApiProtoRecurrence": { - "description": "Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) TODO(b/240850530) add link to validators when created.", + "description": "Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb", "id": "SocialGraphApiProtoRecurrence", "properties": { "dailyRecurrence": { "$ref": "SocialGraphApiProtoDailyRecurrence" }, "every": { - "description": "Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Example: [remind me to call mom every 2nd week]. Default value will be considered 1 (every day,every week,...) and not 0. This is ignored for a SingleRecurrence. Optional.", + "description": "Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Must be a positive int. Example: [remind me to call mom every 2nd week]. If this field isn't set, it will default to 1 (every day,every week, etc). This field is ignored when recurrence_data is a SingleRecurrence. Optional.", "format": "int32", "type": "integer" }, @@ -102173,10 +101808,10 @@ }, "recurrenceStart": { "$ref": "GoogleTypeDateTime", - "description": "The start of the recurrence can be represented as a DateTime. This is ignored for a SingleRecurrence." + "description": "The start of the recurrence can be represented as a DateTime. This field is ignored when recurrence_data is a SingleRecurrence." }, "repeatCount": { - "description": "Will repeat only a finite number of times. This is the original number of times the recurrence will repeat and not how many times are left for it to repeat.", + "description": "Will repeat only a finite number of times. This is the original number of times the recurrence will repeat and not how many times are left for it to repeat. This end type is not currently supported.", "format": "int32", "type": "integer" }, @@ -102616,7 +102251,7 @@ "type": "object" }, "SocialGraphApiProtoYearlyRecurrence": { - "description": "Pattern for a YEARLY recurrence. A YEARLY recurrence is specified using a monthly pattern and a set of months the pattern applies to. Some examples: \"Every January 16\" : monthly_pattern { month_day: 16 } months: JANUARY \"Last day of every April and August\" : monthly_pattern { month_day: -1 } months: APRIL months: AUGUST Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService)", + "description": "Pattern for a YEARLY recurrence. A YEARLY recurrence is specified using a monthly pattern and a set of months the pattern applies to. Some examples: \"Every January 16\" : monthly_pattern { monthly_day_recurrence { month_day: 16 } } months: JANUARY \"Fourth Thursday of November and December\" : monthly_pattern { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 4 } } months: NOVEMBER months: DECEMBER Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService)", "id": "SocialGraphApiProtoYearlyRecurrence", "properties": { "monthlyPattern": { @@ -103121,6 +102756,41 @@ }, "type": "object" }, + "SpamBrainData": { + "description": "This holds SpamBrain values which will be populated to docjoins \u0026 muppet. Proto is copied from spam_brain::SpamBrainData and populated at sitechunked site level (as opposed to the spambrain page classifier score).", + "id": "SpamBrainData", + "properties": { + "site": { + "description": "Sitechunker site granularity for this result", + "type": "string" + }, + "versionedData": { + "description": "Versioned scores of SB classifiers", + "items": { + "$ref": "SpamBrainScore" + }, + "type": "array" + } + }, + "type": "object" + }, + "SpamBrainScore": { + "description": "Message representing versioned scores", + "id": "SpamBrainScore", + "properties": { + "sbScore": { + "description": "The value corresponding to this version.", + "format": "float", + "type": "number" + }, + "versionId": { + "description": "The version id.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "SpamCookbookAction": { "description": "This protocol buffer indicates actions that we take based on Cookbook recipes (see http://cookbook/) matching a particular document.", "id": "SpamCookbookAction", @@ -103254,6 +102924,48 @@ }, "type": "object" }, + "StorageGraphBfgLmsPolicyMetadata": { + "description": "Metadata fields for LMS. See go/lms-online-restrictions for details.", + "id": "StorageGraphBfgLmsPolicyMetadata", + "properties": { + "clientIdsAllowed": { + "items": { + "type": "string" + }, + "type": "array" + }, + "isEditorial": { + "type": "boolean" + }, + "modificationsAllowed": { + "description": "Int values corresponds to the values of image_repository.licensed.api.restrictions.Modification enum.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "regionsAllowed": { + "$ref": "KeGovernanceTypedRegions" + }, + "regionsDisallowed": { + "$ref": "KeGovernanceTypedRegions" + }, + "requiresAttribution": { + "type": "boolean" + }, + "requiresFirstPartyOnly": { + "type": "boolean" + }, + "requiresLinkback": { + "type": "boolean" + }, + "requiresShareAlike": { + "type": "boolean" + } + }, + "type": "object" + }, "StorageGraphBfgPolicyMetadata": { "description": "Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there's no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won't be embargoed automatically; if `availability_end_timestamp` is not set, they won't expire automatically. LINT.IfChange", "id": "StorageGraphBfgPolicyMetadata", @@ -103282,41 +102994,9 @@ }, "type": "array" }, - "lmsClientIdsAllowed": { - "items": { - "type": "string" - }, - "type": "array" - }, - "lmsIsEditorial": { - "description": "The following attributes with `lms_` prefix are for supporting LMS restrictions. See go/lms-online-restrictions for details.", - "type": "boolean" - }, - "lmsModificationsAllowed": { - "description": "Int values corresponds to the values of image_repository.licensed.api.restrictions.Modification enum.", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "lmsRegionsAllowed": { - "$ref": "KeGovernanceTypedRegions" - }, - "lmsRegionsDisallowed": { - "$ref": "KeGovernanceTypedRegions" - }, - "lmsRequiresAttribution": { - "type": "boolean" - }, - "lmsRequiresFirstPartyOnly": { - "type": "boolean" - }, - "lmsRequiresLink": { - "type": "boolean" - }, - "lmsRequiresShareAlike": { - "type": "boolean" + "lmsPolicyMetadata": { + "$ref": "StorageGraphBfgLmsPolicyMetadata", + "description": "Policy metadata fields for LMS data. Only expected to be used by LMS providers -- please consult ke-data-governance@ before populating this field." }, "policySourceType": { "description": "Policy metadata are VERTICAL by default. Vertical policy makers / providers does not need to set this field explicitly.", @@ -107061,6 +106741,13 @@ "LIVEOPS_CLUSTER_SERP_EVENT_LEVEL", "INLINE_DETAILS_AQUALITY_CHECK_PASS", "INLINE_DETAILS_AQUALITY_CHECK_FAIL", + "INLINE_DETAILS_IS_INLINE_URL_FRONTEND", + "INLINE_DETAILS_TQUALITY_CHECK_PASS_FRONTEND", + "INLINE_DETAILS_TQUALITY_CHECK_FAIL_FRONTEND", + "INLINE_DETAILS_AQUALITY_CHECK_PASS_FRONTEND", + "INLINE_DETAILS_AQUALITY_CHECK_FAIL_FRONTEND", + "INLINE_DETAILS_CALLER_AQUALITY_CHECK_PASS_FRONTEND", + "INLINE_DETAILS_CALLER_AQUALITY_CHECK_FAIL_FRONTEND", "FRESH_RESULTS_SEEKING_CURRENT_YEAR_EVENT_LEVEL", "FILTER_TQ_FAILURE_APP", "EDITORIAL_CONTENT_CLUSTER_FHR_SERP_EVENT_LEVEL", @@ -107082,6 +106769,14 @@ "BROAD_INTENT_GAMES_TIMESPENT_EVENT_LEVEL", "PLAY_STORE_IAP_SALES_MINI_DETAILS_PAGE_EAP_PARTNER_APPS_EVENT_LEVEL", "GEARHEAD_ATTEMPT_USB_RECOVERY", + "MDP_P13N_ALL_EVENT_LEVEL", + "MDP_P13N_GAME_QUERY_L5_EVENT_LEVEL", + "MDP_P13N_GAME_QUERY_L6_EVENT_LEVEL", + "MDP_P13N_GAME_QUERY_L7_EVENT_LEVEL", + "MDP_P13N_GAME_QUERY_L8_EVENT_LEVEL", + "MDP_P13N_GAME_QUERY_L9_EVENT_LEVEL", + "SECOND_PASS_POLARIS_RERANKING_EVENT_LEVEL", + "SECOND_PASS_POLARIS_WITH_RANKING_CHANGE_EVENT_LEVEL", "EVENT_LEVEL_TEST_CODE_LIMIT", "RESERVED_4", "RESERVED_5", @@ -107826,6 +107521,13 @@ "INLINE_DETAILS_CALLER_AQUALITY_CHECK_PASS_SESSION_LEVEL", "INLINE_DETAILS_CALLER_AQUALITY_CHECK_FAIL_SESSION_LEVEL", "INLINE_DETAILS_IS_INLINE_URL_SESSION_LEVEL", + "INLINE_DETAILS_IS_INLINE_URL_FRONTEND_SESSION_LEVEL", + "INLINE_DETAILS_TQUALITY_CHECK_PASS_FRONTEND_SESSION_LEVEL", + "INLINE_DETAILS_TQUALITY_CHECK_FAIL_FRONTEND_SESSION_LEVEL", + "INLINE_DETAILS_AQUALITY_CHECK_PASS_FRONTEND_SESSION_LEVEL", + "INLINE_DETAILS_AQUALITY_CHECK_FAIL_FRONTEND_SESSION_LEVEL", + "INLINE_DETAILS_CALLER_AQUALITY_CHECK_PASS_FRONTEND_SESSION_LEVEL", + "INLINE_DETAILS_CALLER_AQUALITY_CHECK_FAIL_FRONTEND_SESSION_LEVEL", "SENT_EMAIL_ENTER_GRACE_PERIOD_SESSION_LEVEL", "SENT_EMAIL_ENTER_SUSPENDED_PERIOD_SESSION_LEVEL", "ANALYTICS_AD_LINKING_RECOMMENDATION_ELIGIBLE_SESSION_LEVEL", @@ -107981,7 +107683,23 @@ "PLANOGRAM_MERCH_AMERICAS_GAMES_PAYPAL_SESSION_LEVEL", "BROAD_INTENT_GAMES_TIMESPENT_SESSION_LEVEL", "ELIGIBLE_FOR_MANAGE_IN_APP_DETAILS_SESSION_LEVEL", - "SEE_REENGAGEMENT_ACC_SESSION_LEVEL", + "ELIGIBLE_FOR_ACC_SESSION_LEVEL", + "ELIGIBLE_FOR_ACQUISITION_ACC_SESSION_LEVEL", + "ELIGIBLE_FOR_REENGAGEMENT_ACC_SESSION_LEVEL", + "MDP_P13N_ALL_SESSION_LEVEL", + "MDP_P13N_GAME_QUERY_L5_SESSION_LEVEL", + "MDP_P13N_GAME_QUERY_L6_SESSION_LEVEL", + "MDP_P13N_GAME_QUERY_L7_SESSION_LEVEL", + "MDP_P13N_GAME_QUERY_L8_SESSION_LEVEL", + "MDP_P13N_GAME_QUERY_L9_SESSION_LEVEL", + "VIDEO_CAN_AUTOPLAY", + "VIDEO_CANNOT_AUTOPLAY", + "YOUTUBE_OPT_IN_NOTIFICATION_DRIVEN_PREFETCH_SESSION_LEVEL", + "YOUTUBE_COUNTERFACTUAL_OPT_IN_NOTIFICATION_DRIVEN_PREFETCH_SESSION_LEVEL", + "YOUTUBE_NOT_OPT_IN_NOTIFICATION_DRIVEN_PREFETCH_SESSION_LEVEL", + "YOUTUBE_FROM_LANDING_PAGE_SESSION_LEVEL", + "SECOND_PASS_POLARIS_RERANKING_SESSION_LEVEL", + "SECOND_PASS_POLARIS_WITH_RANKING_CHANGE_SESSION_LEVEL", "SESSION_LEVEL_TEST_CODE_LIMIT", "SHOULD_SEE_LIVE_OP_CLUSTER_USER_LEVEL", "CART_ABANDONMENT_USER_LEVEL", @@ -108185,6 +107903,7 @@ "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_CTA_USER_LEVEL", "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_ON_SERP_MDP_USER_LEVEL", "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_ON_APP_DETAILS_PAGE_USER_LEVEL", + "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_ON_APP_DP_USER_LEVEL", "CART_ABANDONMENT_SUBSCRIPTION_ONE_TIME_PASS_USER_LEVEL", "LEGOLAND_INSTANT_FOP_SCREEN_USER_LEVEL", "LEGOLAND_INSTANT_FOP_SCREEN_WITH_PROMOTION_USER_LEVEL", @@ -108419,6 +108138,11 @@ "PLAY_ONBOARDING_QUEST_GAMES_HOME_USER_LEVEL", "SERVED_GPP_ONBOARDING_QUEST_USER_LEVEL", "YOUTUBE_OPTED_IN_NOTIFICATION_DRIVEN_PREFETCH_USER_LEVEL", + "PLAY_ONBOARDING_QUEST_GAMES_HOME_SERVER_USER_LEVEL", + "PCH_O2_WITH_CRE_USER_LEVEL", + "MERCH_USER_JOURNEY_ROBLOX_SPEND_USER_LEVEL", + "PBUY_FINE_TUNING_WITH_TEXT_TREAT_USER_LEVEL", + "PLAY_GAMES_ACHIEVEMENT_LOYALTY_QUEST_USER_LEVEL", "USER_LEVEL_TEST_CODE_LIMIT" ], "enumDescriptions": [ @@ -108695,6 +108419,13 @@ "", "Event level test codes containing result of aQuality lookup during market details url matching. A failed aQuality result suppresses inline details.", "", + "Event level test code for Aquality/Tquality filtering in LMD project. This is a duplicated testcode created for logging in frontend.", + "", + "", + "", + "", + "", + "", "Event level test code for tracking fresh results seeking within the current year search queries.", "Event level test code for when we filtered \u003e=1 apps due to tq failure.", "Event level test code for Editorial Content/Articles in SERP (FHR)", @@ -108716,6 +108447,14 @@ "TestCode for Broad Intent Games TimeSpent Event Level.", "Test codes for the feature and each early-access partners for the Play Store IAP sales project at event-level. go/play-store-iap-sales-dd", "USB connection recovery.", + "MDP P13N", + "", + "", + "", + "", + "", + "Second pass polaris reranking event level.", + "Second pass polaris with ranking change event level.", "", "", "", @@ -109460,6 +109199,13 @@ "", "", "Session level test code indicating external details URL is an inline URL.", + "Session level test code for Aquality/Tquality filtering in LMD project. This is a duplicated testcode created for logging in frontend.", + "", + "", + "", + "", + "", + "", "Session level test code that indicates that decline email is sent when the subscription enters grace period.", "Session level test code that indicates that decline email is sent when the subscription enters suspended period.", "Session level test code that indicates that user was eligible for ad linking recommendation.", @@ -109615,7 +109361,23 @@ "Session level test code for merch run planogram experiment", "TestCode for Broad Intent Games TimeSpent Session Level.", "Session level test code for eligible users for manage in-app details", - "Session level test code for users that see reengagement ACC", + "Session level test code for users are eligible for ACC", + "Session level test code for users are eligible for acquisition ACC", + "Session level test code for users are eligible for reengagement ACC", + "MDP P13N", + "", + "", + "", + "", + "", + "Session level test code to tell if a video can autoplay for the given user based on their settings and connection status", + "", + "Session level test code for YouTube commerce, tracking users who opt in notification driven prefetch.", + "", + "", + "", + "Second pass polaris reranking session level.", + "Second pass polaris with ranking change session level.", "", "User should see the live op cluster.", "Cart abandonment flow for purchase flow.", @@ -109819,6 +109581,7 @@ "", "", "", + "", "User saw/would have seen the subscription one time pass offer", "when abandonments the cart.", "", @@ -110053,6 +109816,11 @@ "User level test code for Play Onboarding quest, tracking users who are eligible for Play Onboarding quest in Games Home", "User level test code for users who have been served GPP onboarding quest.", "User level test code for YouTube commerce, tracking users who opted in notification driven prefetch.", + "User level test code for Play Onboarding quest, tracking users who are eligible for Play Onboarding quest in Games Home. This test code is logged on the server side.", + "User level test code for tracking users who are being shown PersistentCartHeader through purchase flow. This test code is logged on the server side.", + "User level test code for Merch user journey roblox spend experiment. This test code is logged on the server side.", + "User level test code for new uplift modeling architecture with campaign features in treatment tower.", + "User level test code for Non-Play Growth Events experiment (go/npge-prd). Logged on the server side and applied to users that visit Loyalty Home and are eligible to receive a quest with Play Games Achievement tasks, regardless of whether the quest was shown or held back.", "" ], "type": "string" @@ -110070,7 +109838,7 @@ "type": "object" }, "VendingConsumerProtoTrustedGenomeEntity": { - "description": "Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity.", + "description": "Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 10", "id": "VendingConsumerProtoTrustedGenomeEntity", "properties": { "categoryId": { @@ -110086,6 +109854,10 @@ "format": "int32", "type": "integer" }, + "predicateName": { + "description": "The name of the relation between the app and the entity. Required.", + "type": "string" + }, "queryText": { "description": "The localized query string for this trusted genome entity. This query will be used when we want to bring users to SERP on click.", "type": "string" @@ -110460,7 +110232,8 @@ "NS_DEMO", "NS_KARTO", "NS_CONTRIB_SERVICE_SHARED", - "NS_CONTRIB_SERVICE_GEO_UGC" + "NS_CONTRIB_SERVICE_GEO_UGC", + "NS_SEARCH_SPORTS" ], "enumDescriptions": [ "Default (invalid) namespace if the field is not set.", @@ -110500,7 +110273,8 @@ "Namespace for the Demo tier used by new clients to try things out.", "Namespace for Karto videos.", "Namespace for shared ContribService UGC videos.", - "Namespace for GEO UGC videos processed by ContribService. Please receive approval via go/vp-newclients before adding a new namespace." + "Namespace for GEO UGC videos processed by ContribService.", + "Namespace for Search Sports vertical videos. Please receive approval via go/vp-newclients before adding a new namespace." ], "type": "string" } @@ -111616,6 +111390,7 @@ "SHOPPING_COLOR_INFO_V1_V2", "SHOPPING_COLOR_INFO_V3", "SHOPPING_COLOR_INFO_V3_WITHOUT_PER_DOMAIN_OUTPUTS", + "SHOPPING_COLOR_SAMPLING_V1", "FOODNET_WIC_V1", "FOODNET_WIC_V2", "SINGLE_IMAGE_HOLISTIC_STABLE", @@ -111720,6 +111495,7 @@ "ColorInfo versions", "When both SHOPPING_COLOR_INFO_V3_WITHOUT_PER_DOMAIN_OUTPUTS and SHOPPING_COLOR_INFO_V3 are in the request, SHOPPING_COLOR_INFO_V3's response is returned.", "", + "", "FoodNet whole image classifier versions.", "", "Single Image Holistic versions.", @@ -113496,7 +113272,9 @@ "ASR_TRANSCRIPT", "COMMENT", "GENERATIVE_ASR_V2", - "SUMMARY_SEGMENT" + "SUMMARY_SEGMENT", + "OCR_EDU", + "ASR_SPAN_EDU" ], "enumDescriptions": [ "", @@ -113523,7 +113301,9 @@ "Anchors where each timed anchor represents one sentence in the ASR transcript.", "Anchors extracted from a YouTube comment.", "Generative ASR anchors V2.", - "Anchors pointing to the conclusion/summary part of the video. (go/vs-find-summary-segment)" + "Anchors pointing to the conclusion/summary part of the video. (go/vs-find-summary-segment)", + "OCR and ASR anchors generated for educational videos in edu Raffia Overlay.", + "" ], "type": "string" }, @@ -113878,7 +113658,9 @@ "ASR_TRANSCRIPT", "COMMENT", "GENERATIVE_ASR_V2", - "SUMMARY_SEGMENT" + "SUMMARY_SEGMENT", + "OCR_EDU", + "ASR_SPAN_EDU" ], "enumDescriptions": [ "", @@ -113905,7 +113687,9 @@ "Anchors where each timed anchor represents one sentence in the ASR transcript.", "Anchors extracted from a YouTube comment.", "Generative ASR anchors V2.", - "Anchors pointing to the conclusion/summary part of the video. (go/vs-find-summary-segment)" + "Anchors pointing to the conclusion/summary part of the video. (go/vs-find-summary-segment)", + "OCR and ASR anchors generated for educational videos in edu Raffia Overlay.", + "" ], "type": "string" }, @@ -113993,7 +113777,9 @@ "ASR_TRANSCRIPT", "COMMENT", "GENERATIVE_ASR_V2", - "SUMMARY_SEGMENT" + "SUMMARY_SEGMENT", + "OCR_EDU", + "ASR_SPAN_EDU" ], "enumDescriptions": [ "", @@ -114020,7 +113806,9 @@ "Anchors where each timed anchor represents one sentence in the ASR transcript.", "Anchors extracted from a YouTube comment.", "Generative ASR anchors V2.", - "Anchors pointing to the conclusion/summary part of the video. (go/vs-find-summary-segment)" + "Anchors pointing to the conclusion/summary part of the video. (go/vs-find-summary-segment)", + "OCR and ASR anchors generated for educational videos in edu Raffia Overlay.", + "" ], "type": "string" }, @@ -126161,6 +125949,7 @@ "WEB_GVP_ADS", "ANDROID_GVP_ADS", "IOS_GVP_ADS", + "VAST_GVP_ADS", "GOOGLE_ASSISTANT", "GOOGLE_LIST_RECS", "GOOGLE_MEDIA_ACTIONS", @@ -126260,6 +126049,7 @@ "GVP clients (IMA and GMA SDKs) go/gvp-sdk These are ad SDKs used by non-YouTube publishers to play ads, including YouTube hosted ads. The main interaction with YouTube is for TrueView, which increments YouTube viewcount of the ad video after the delay is reached. Thus, the ad SDKs send requests to the viewcount/VSS pipeline. IMA SDK", "GMA SDK Android", "GMA SDK iOS", + "VAST based SDKs", "Middleware or Frontend Server Clients Google Assistant integration with Voz", "List Recs Service Clients", "Media Actions Service Clients", @@ -126832,13 +126622,8 @@ "GEO_TYPES_COLLECTION_BUSINESSES", "GEO_TYPES_COLLECTION_POTENTIALLY_SENSITIVE", "GEO_TYPE", - "ADDED_DURING_GEO_ENTITIES_PROMOTION", - "GEO_TYPE_COMPOUND_BUILDING", - "GEO_TYPE_POLITICAL", "GEO_TYPES_COLLECTION_SMALL_POLITICALS", - "GEO_TYPES_COLLECTION_CITY_LEVEL_POLITICALS", - "GEO_TYPES_COLLECTION_LARGE_POLITICALS", - "GEO_TYPES_COLLECTION_NATURAL_FEATURES", + "ADDED_DURING_GEO_ENTITIES_PROMOTION", "DENORM_LOCATION_TO_CONTAINING_COUNTRY", "DENORM_LOCATION_TO_CONTAINING_REGION", "DENORM_LOCATION_TO_CONTAINING_CITY", @@ -126884,14 +126669,14 @@ "The entity refers to a creator who has uploaded this video on a VEVO channel with no other creators. go/avg-use-cases go/artist-channels contact: ytm-classification-eng@google.com", "The entity refers to a creator who has uploaded this video on a channel that they are verified to control, but not their official channel go/avg-use-cases go/artist-channels contact: ytm-classification-eng@google.com", "The entity refers to a creator who has uploaded this video on a channel that they are verified to be related to, but may not control exclusively go/avg-use-cases go/artist-channels contact: ytm-classification-eng@google.com", - "The entity refers to the TV show that this video contains footage of, in a way that is appropriate for watching the show itself. A show with commentary voiceover shouldn't get this context. Typically determined using ContentID with audiovisual matches. This means that a show which is not claimed can't have this context.", + "Deprecated. The context is currently unused and very sparse populated. We plan to delete it.", "The entity refers to a TV show genre added from a TV show annotated on this video. Note that this does not imply that TV_SHOW_FOOTAGE is present on any annotation for this video; the show may have been obtained using metadata methods and we don't know for sure that footage is present.", "The entity refers to a movie genre added from a movie annotated on this video. Note that this might also trigger for shoulder content such as trailers or interviews.", "The entity refers to the top scored game title(s) for a particular gaming related video.", - "The entity refers to an item equiped by some \"object\" (in the subject-predicate-object sense) in the game in this video. This context comes from the game state annotation process detailed at go/game-state-annotation-design.", - "The entity refers to an item used by some \"object\" (in the subject-predicate-object sense) in the game in this video. This context comes from the game state annotation process detailed at go/game-state-annotation-design, and an example of its generation and meaning is described in go/clash-legos-semantics.", - "The entity refers to a character who is an ally of some \"object\" (in the subject-predicate-object sense) in the game in this video. This context comes from the game state annotation process detailed at go/game-state-annotation-design.", - "The entity refers to a character who is controlled by some \"object\" (in the subject-predicate-object sense) in the game in this video. This context comes from the game state annotation process detailed at go/game-state-annotation-design.", + "Deprecated. The experiment on top of this has not launched.", + "Deprecated. The experiment on top of this has not launched.", + "Deprecated. The experiment on top of this has not launched.", + "Deprecated. The experiment on top of this has not launched.", "The entity refers to a Legos annotation that is manually requested by the live discovery team for sports live streams.", "The entity refers to a creator who has uploaded this video on one of their channels that is present as a social profile in KG, e.g. https://screenshot.googleplex.com/RCNN3YPizpe.png. Annotations with this context may overlap with CREATOR_OFFICIAL_CHANNEL which is Disco3 specific.", "Deprecated context, do not use.", @@ -126929,11 +126714,6 @@ "Context used by Geo that indicates if an entity is a geo feature.", "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", - "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", - "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", - "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", - "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", - "Deprecated. See b/244583433. Instead, consider relying on GEO_TYPE and looking up individual KG types in YTKS.", "Assigned to an entity that has been denormalized from an entity which it geographically contains according to the containing entity's type.", "", "", diff --git a/contentwarehouse/v1/contentwarehouse-gen.go b/contentwarehouse/v1/contentwarehouse-gen.go index 01081ea9246..f09f303e481 100644 --- a/contentwarehouse/v1/contentwarehouse-gen.go +++ b/contentwarehouse/v1/contentwarehouse-gen.go @@ -153,6 +153,7 @@ func NewProjectsLocationsService(s *Service) *ProjectsLocationsService { rs := &ProjectsLocationsService{s: s} rs.DocumentSchemas = NewProjectsLocationsDocumentSchemasService(s) rs.Documents = NewProjectsLocationsDocumentsService(s) + rs.Operations = NewProjectsLocationsOperationsService(s) rs.RuleSets = NewProjectsLocationsRuleSetsService(s) rs.SynonymSets = NewProjectsLocationsSynonymSetsService(s) return rs @@ -165,6 +166,8 @@ type ProjectsLocationsService struct { Documents *ProjectsLocationsDocumentsService + Operations *ProjectsLocationsOperationsService + RuleSets *ProjectsLocationsRuleSetsService SynonymSets *ProjectsLocationsSynonymSetsService @@ -212,6 +215,15 @@ type ProjectsLocationsDocumentsReferenceIdService struct { s *Service } +func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService { + rs := &ProjectsLocationsOperationsService{s: s} + return rs +} + +type ProjectsLocationsOperationsService struct { + s *Service +} + func NewProjectsLocationsRuleSetsService(s *Service) *ProjectsLocationsRuleSetsService { rs := &ProjectsLocationsRuleSetsService{s: s} return rs @@ -3109,6 +3121,12 @@ type AppsPeopleOzExternalMergedpeopleapiAffinity struct { // "SKILLSSTACK_AFFINITY" // "WHOSTORY_AFFINITY" // "PHOTOS_PARTNER_SHARING_EMAIL_ONLY" + // "MEMORIZE_AFFINITY" + // "BETTANY_AFFINITY" + // "BASECAMP_AFFINITY" + // "DRIVE_SEARCH_FILTER_AFFINITY" + // "CULTURE_EVENTS_CALENDAR_AFFINITY" + // "DATABRIDGE_CONSOLE_AFFINITY" AffinityType string `json:"affinityType,omitempty"` // ContainerId: The ID of the container @@ -11147,7 +11165,7 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "ADD_FINGERPRINT" // "AIRPLANE_MODE" // "ALARM_VOLUME" - // "ALARM_SOUND" + // "ALARM_SOUND" - Deprecated, use DEFAULT_ALARM_SOUND instead. // "AMBIENT_DISPLAY_ALWAYS_ON" // "AMBIENT_DISPLAY_NEW_NOTIFICATION" // "ANDROID_AUTO" @@ -11156,6 +11174,7 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "APP_DATA_USAGE" // "APP_DETAILS" // "APP_SHORTCUT" + // "APPS_NOTIFICATIONS" // "APPS_STORAGE" // "ASSISTANT_ACCOUNT" // "ASSISTANT_FACE_MATCH" @@ -11169,6 +11188,7 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "BATTERY_PERCENTAGE" // "BATTERY_PRESENT" // "BATTERY_SAVER" + // "BATTERY_SAVER_SCHEDULE" // "BATTERY_SHARE" // "BATTERY_USAGE" // "BIOMETRIC" @@ -11182,6 +11202,8 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "CAMERA_DOUBLE_TWIST" // "CAST" // "COLOR_INVERSION" + // "COLOR_CORRECTION" + // "CONVERSATIONS" // "CHARGING_SOUNDS_AND_VIBRATION" // "CHARGING_STATE" // "CONNECTED_DEVICES" @@ -11196,6 +11218,8 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "DATA_WARNING" - Toggle to enable data use warning // "DATA_WARNING_LEVEL" - The mobile data use after which a warning is // shown to the user. + // "DEFAULT_ALARM_SOUND" + // "DEFAULT_NOTIFICATION_SOUND" // "DEFAULT_APPS" // "DEVELOPER_OPTIONS" // "DEVICE_NAME" @@ -11213,17 +11237,22 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "EMERGENCY_ALERTS" // "EMERGENCY_INFORMATION" // "ETHERNET_TETHERING" + // "EXTRA_DIM" - Makes screen extra dark. + // "EXTREME_BATTERY_SAVER" // "FACTORY_RESET" + // "FIND_MY_DEVICE" // "FLASHLIGHT" // "FOCUS_MODE" // "FONT_SIZE" // "FREE_UP_SPACE" - // "GESTURES" - // "HAPTIC_FEEDBACK_VIBRATION" + // "GESTURES" - A page for device gestures + // "HAPTIC_FEEDBACK_VIBRATION" - Deprecated, use VIBRATION instead. + // "HARD_KEYBOARD" // "HEADS_UP" // "HIGH_REFRESH_RATE" - // "HOT_SPOT" - // "HOTSPOT_TETHERING" + // "HOT_SPOT" - Toggle for internet sharing via WiFi. + // "HOTSPOT_TETHERING" - Common settings page for internet sharing via + // various means. // "HOT_WORD" // "IP_ADDRESS" - Show my IP address // "IMPROVE_LOCATION_ACCURACY" @@ -11231,9 +11260,11 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "KEYBOARD_SHORTCUTS" // "LIFT_CHECK_PHONE" // "LOCATION" + // "LOCATION_HISTORY" // "LOCATION_BLUETOOTH_SCANNING" // "LOCATION_WIFI_SCANNING" - // "LOCK_SCREEN" + // "LOCK_SCREEN" - Settings page for what is visible on the lock + // screen. // "LOCK_SCREEN_DEVICE_CONTROLS" // "LOCK_SCREEN_WALLET" // "MAC_ADDRESS" - Show my MAC address @@ -11244,6 +11275,10 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "MANIFY_TRIPLE_TAP" // "MEDIA" // "MEDIA_VOLUME" + // "MICROPHONE_ACCESS" - Microphone Access is a toggleable setting + // that controls if Microphone usage is allowed at the system level or + // not. It is not the per-App Microphone permission page. + // https://screenshot.googleplex.com/4hrskftPSur7hHh // "MOBILE" - Wireless internet settings, including WiFi, Cellular, // etc. // "MOBILE_DATA" - Setting to enable/disable cellular data connection @@ -11259,13 +11294,19 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "NIGHT_LIGHT_SWITCH" // "NIGHT_MODE" // "NOTIFICATION_BADGE" - // "NOTIFICATION_SOUND" + // "NOTIFICATION_SOUND" - Deprecated, use DEFAULT_NOTIFICATION_SOUND + // instead. // "NOTIFICATION_ON_SCREEN" + // "NOTIFICATION_HISTORY" // "NOTIFY_FOR_PUBLIC_NETWORKS" // "ONEHANDED_MODE" - // "PASSWORD" - // "PERMISSION_MANAGER" + // "OS_VERSION" + // "PASSWORD" - Password manager + // "PERMISSION_MANAGER" - Shows permissions and allows add/remove + // allowed apps. + // "PERMISSION_USAGE" - Shows usage of each permission by app. // "PERSONALIZATION" + // "PRINTING" // "PHONE_NUMBER" // "PICTURE_IN_PICTURE" // "POINTER_SPEED" @@ -11279,16 +11320,22 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "SCREEN_LOCKING_SOUND" // "SCREEN_MAGNIFICATION" // "SCREEN_TIMEOUT" + // "SCREEN_LOCK" - Settings page for screen locking security methods. + // "SCREEN_SAVER" // "SELECT_TO_SPEAK" // "SET_TIME_AUTOMATICALLY" // "SET_TIME_ZONE_AUTOMATICALLY" // "SETTINGS" - // "SIM" + // "SIM" - Currently active/primary SIM. + // "SIM_MANAGER" // "SPEECH_RATE" // "STORAGE_USAGE" // "SWIPE_FOR_NOTIFICATION" // "SWITCH_ACCESS" // "SYSTEM_UPDATE" + // "SYSTEM_NAVIGATION" - Settings page for configuring how navigation + // between apps is done. Specifically android has choice between Buttons + // of Gestures mode. // "TALKBACK_PASSWORDS" // "TEXT_TO_SPEECH" // "TIME_ZONE" @@ -11296,9 +11343,14 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "USB" // "USB_TETHERING" // "VERBOSE_TTS" - // "VIBRATE" - Corresponds to "Vibration & haptics" toggle in the - // settings app. Reference: http://shortn/_wE1WCid2aM - // "VIBRATION_MODE" + // "VIBRATE" - Deprecated, use VIBRATION instead. + // "VIBRATION" - Vibration master toggle - controls all vibration + // functions. Corresponds to "Vibration & haptics" toggle in the Android + // settings app. + // "VIBRATION_MODE" - Controls whether the ringer mode will be silent + // or will vibrate. Details in + // https://developer.android.com/reference/android/media/AudioManager#RINGER_MODE_VIBRATE + // Different from VIBRATION from above. // "VOICE" // "VOLUME_LEVEL" // "WAKE_SCREEN_FOR_NOTIFICATIONS" @@ -11308,7 +11360,7 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "WIFI_ADD_NETWORK" // "WIFI_ADD_NETWORK_QR_CODE" // "WIFI_CALLING" - // "WIFI_HOTSPOT" + // "WIFI_HOTSPOT" - Duplicate, use HOT_SPOT instead // "ABOUT_PHONE" - Begin of NGA proto consistence // "ACCOUNTS" // "APPLICATION" @@ -11324,7 +11376,7 @@ type AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty struct { // "DIGITAL_WELLBEING" // "DISPLAY" // "LANGUAGE" - // "NIGHT_LIGHT" + // "NIGHT_LIGHT" - Duplicate, use NIGHT_MODE instead // "NOTIFICATION" // "NOTIFICATION_VOLUME" // "PHONE_RINGTONE" @@ -15123,8 +15175,14 @@ func (s *AssistantApiLocationCapabilities) MarshalJSON() ([]byte, error) { // AssistantApiLoggingOnlyData: Data which is produced for logging and // debugging. Servers MUST NOT use this for any other purposes, such as -// branching on it. Next ID: 14 +// branching on it. Next ID: 15 type AssistantApiLoggingOnlyData struct { + // AccountIndex: The index of the account on the device. Useful when + // there are multiple accounts on a device such as distinguishing + // primary user data from secondary users. There is no guarantee that + // this is a stable number but is relatively stable in practice. + AccountIndex int64 `json:"accountIndex,omitempty"` + // AcpVersion: A user-readable string describing the ACP version // (go/acp-version) of the client app used by the user to originate the // conversation. @@ -15206,7 +15264,7 @@ type AssistantApiLoggingOnlyData struct { // "eng-no-update", etc. VirtualReleaseChannel string `json:"virtualReleaseChannel,omitempty"` - // ForceSendFields is a list of field names (e.g. "AcpVersion") to + // ForceSendFields is a list of field names (e.g. "AccountIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -15214,10 +15272,10 @@ type AssistantApiLoggingOnlyData struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AcpVersion") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as + // NullFields is a list of field names (e.g. "AccountIndex") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` @@ -16111,6 +16169,7 @@ type AssistantApiScreenCapabilities struct { // "CONCISE_TEXT" - Concise Text go/concise-text-responses // "PROTO_LAYOUT" - Proto Layout, the layout for Proto Tiles // go/prototiles + // "ELEMENTS" - Elements, the layout for xUIKit go/xuikit SupportedRenderingFormat string `json:"supportedRenderingFormat,omitempty"` // SupportedScreenStates: The screen states that the client supports. @@ -18968,12 +19027,14 @@ type AssistantApiSuggestionsSupport struct { ClickImpersonationSupported bool `json:"clickImpersonationSupported,omitempty"` // ColoredChipBackgroundBorderSupported: Whether client supports - // suggestion chips with colored background/border. + // suggestion chips with colored background/border. Deprecated in favor + // of go/color-token-suggestion-chip. ColoredChipBackgroundBorderSupported bool `json:"coloredChipBackgroundBorderSupported,omitempty"` // ColoredChipTextSupported: Whether client supports suggestion chips // with colored text. See design doc: - // http://go/opa-suggestions-ux-eng-design. + // http://go/opa-suggestions-ux-eng-design. Deprecated in favor of + // go/color-token-suggestion-chip. ColoredChipTextSupported bool `json:"coloredChipTextSupported,omitempty"` // DebugDataSupported: Whether client supports suggestions debug data to @@ -21519,19 +21580,23 @@ type AssistantGroundingRankerContactGroundingProviderFeatures struct { MatchedNameType string `json:"matchedNameType,omitempty"` // NumAlternateNameFromFuzzyContactMatch: Number of alternate contact - // names from fuzzy contact match. + // names from fuzzy contact match. (Not suggest using it since it can + // change due to retrieval iteration) NumAlternateNameFromFuzzyContactMatch float64 `json:"numAlternateNameFromFuzzyContactMatch,omitempty"` // NumAlternateNamesFromS3: Number of alternate contact names from - // S3_HYPOTHESES. + // S3_HYPOTHESES. (Not suggest using it since it can change due to + // retrieval iteration) NumAlternateNamesFromS3 float64 `json:"numAlternateNamesFromS3,omitempty"` // NumAlternativeNamesFromInterpretation: Number of alternate contact - // names from interpretation. + // names from interpretation. (Not suggest using it since it can change + // due to retrieval iteration) NumAlternativeNamesFromInterpretation float64 `json:"numAlternativeNamesFromInterpretation,omitempty"` // NumCandidates: Number of contacts populated by the contact Grounding - // Provider. + // Provider. (Not suggest using it since it can change due to retrieval + // iteration) NumCandidates float64 `json:"numCandidates,omitempty"` // Possible values: @@ -22705,7 +22770,6 @@ type AssistantLogsDeviceMediaSessionLog struct { // "MOVIE" // "PHOTO" // "TV_SHOW_EPISODE" - // "PODCAST_EPISODE" // "MUSIC_GENRE" // "AUDIO_BOOK" // "CHAPTER" @@ -22721,6 +22785,8 @@ type AssistantLogsDeviceMediaSessionLog struct { // "NEWS" // "NARRATED_WEB" // "AUDIO_STORY" - Representing a short audio story. go/tmas-design + // "PODCAST_SERIES" - Represent different kinds of podcast content + // "PODCAST_EPISODE" MediaType string `json:"mediaType,omitempty"` // PlaybackState: The playback states of the session. @@ -27079,10 +27145,10 @@ func (s *CommerceDatastoreImageDeepTagsModelOutput) MarshalJSON() ([]byte, error } // CompositeDoc: Protocol record used for collecting together all -// information about a document. Please consult go/dme for two basic -// questions about `CompositeDoc`: - Where should I look up certain -// information (e.g: pagerank, language)? - What does each field in -// CompositeDoc mean and who should I contact if I have questions? To +// information about a document. Please consult go/dj-explorer for two +// basic questions about `CompositeDoc`: - Where should I look up +// certain information (e.g: pagerank, language)? - What does each field +// in CompositeDoc mean and who should I contact if I have questions? To // add a new field into CompositeDoc, or change existing field's size // significantly, please file a ticket at go/dj-new-field, fill in // necessary information and get approved by docjoin-access@ team. Next @@ -29965,8 +30031,10 @@ type CountryLocationInfo struct { // for a user to meet a taxi, ridesharing vehicle, or general driver. // "TYPE_REGULATED_AREA" - An area controlled in some way by an // authoritative source, such as a government-designated COVID - // containment zone. Features of this type should have one or more gcids - // corresponding to their specific regulation. + // containment zone or an area under government sanctions. Features of + // this type should have one or more gcids corresponding to their + // specific regulation, and client handling of these features may vary + // based on the type of regulation. // "TYPE_LOGICAL_BORDER" - A grouping of TYPE_BORDER features ("border // segments"), which together represent a border between two features of // the same type. @@ -33256,6 +33324,8 @@ func (s *FatcatCompactRephilClustersCluster) MarshalJSON() ([]byte, error) { type FatcatCompactTaxonomicClassification struct { Category []*FatcatCompactTaxonomicClassificationCategory `json:"category,omitempty"` + ClassifierVersion string `json:"classifierVersion,omitempty"` + // Taxonomy: Either taxonomy will be set, using the enum above, or // taxonomy_name will be set (if the taxonomy is not one of the ones in // the enum) - never both @@ -35977,6 +36047,27 @@ type GeostoreComposableItemProto struct { // given currency. Price *GeostorePriceRangeProto `json:"price,omitempty"` + // PriceFormat: Represents which price format is being used by this + // item, which determines the usage/meaning of the “price” field + // above. Optional – the default value is legal and safe (represents + // no price if the “price” field is unset). + // + // Possible values: + // "PRICE_FORMAT_DEFAULT" - Default price format which uses the + // PriceRangeProto (set or unset) in the "price" field above to + // represent a price interval, or lack thereof. + // "PRICE_FORMAT_VARIES" - Value for a price which explicitly varies, + // i.e. it should show as “Price may vary" or similar. If this is the + // price_format, contents of the "price" field will be ignored. + PriceFormat string `json:"priceFormat,omitempty"` + + // RankingHint: Numerical score which can be provided by data sources to + // indicate preferred item ordering. This is purely a hint – we are + // not required to followed it if we have a different order we think is + // better. Higher scores represent items that should be shown more + // prominently/earlier. Optional. + RankingHint float64 `json:"rankingHint,omitempty"` + // ForceSendFields is a list of field names (e.g. "CallToAction") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -36000,6 +36091,20 @@ func (s *GeostoreComposableItemProto) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +func (s *GeostoreComposableItemProto) UnmarshalJSON(data []byte) error { + type NoMethod GeostoreComposableItemProto + var s1 struct { + RankingHint gensupport.JSONFloat64 `json:"rankingHint"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.RankingHint = float64(s1.RankingHint) + return nil +} + // GeostoreCountComparisonProto: A count value tagged with a comparison // operator. This can be used for axle count, trailer count, etc. type GeostoreCountComparisonProto struct { @@ -36334,7 +36439,7 @@ type GeostoreDataSourceProto struct { // "PROVIDER_GOOGLE" - ABSTRACT // "PROVIDER_GOOGLE_HAND_EDIT" // "PROVIDER_GOOGLE_BORDERS" - All new "Google" provider entries must - // be full ints. The next available ID is: 0x111730AE + // be full ints. The next available ID is: 0x111730B1 // "PROVIDER_GOOGLE_SUBRANGE" - ABSTRACT // "PROVIDER_GOOGLE_GT_FUSION" // "PROVIDER_GOOGLE_ZAGAT_CMS" @@ -36508,6 +36613,9 @@ type GeostoreDataSourceProto struct { // "PROVIDER_GOOGLE_GEO_LDE" // "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING" // "PROVIDER_GOOGLE_UGC_AGGREGATION" + // "PROVIDER_GOOGLE_3D_BASEMAP" + // "PROVIDER_GOOGLE_MAPFACTS_PRIVACY" + // "PROVIDER_GOOGLE_GT_ALF" // "PROVIDER_GOOGLE_LOCALSEARCH" - The next new "Google" provider // entries should be placed above. // "PROVIDER_GOOGLE_TRANSIT" - UMBRELLA @@ -37052,7 +37160,8 @@ type GeostoreDataSourceProto struct { // "PROVIDER_MASTERCARD" // "PROVIDER_VATTENFALL" // "PROVIDER_VIETGIS" - // "PROVIDER_UNITE" - Note: Next available value is 0x126E. + // "PROVIDER_UNITE" + // "PROVIDER_NEOGY" - Note: Next available value is 0x126F. Provider string `json:"provider,omitempty"` // RawMetadata: For every key that is used in raw_data from this source, @@ -38171,8 +38280,12 @@ type GeostoreExistenceProto struct { // values. // "BOGUS" - Bogus data - doesn't represent a real world geographic // place or is just largely bad/incorrect data. - // "PRIVATE" - Considered "private" data and we're legally (or - // otherwise) obligated to remove it. + // "PRIVATE" - Considered "private" data. We do not want to display + // this data to users, but we allow it to remain in MapFacts + // indefinitely. + // "PRIVATE_MUST_PURGE" - Considered "private" data, which has been or + // will soon be fully removed from MapFacts and related systems (other + // than feature id and existence metadata). // "SPAM" - Bad data that was intentionally/maliciously contributed. // "UNSUPPORTED" - Not enough data to support the existence of the // feature. Different from the BOGUS case in that there is no positive @@ -39889,8 +40002,10 @@ type GeostoreFeatureProto struct { // for a user to meet a taxi, ridesharing vehicle, or general driver. // "TYPE_REGULATED_AREA" - An area controlled in some way by an // authoritative source, such as a government-designated COVID - // containment zone. Features of this type should have one or more gcids - // corresponding to their specific regulation. + // containment zone or an area under government sanctions. Features of + // this type should have one or more gcids corresponding to their + // specific regulation, and client handling of these features may vary + // based on the type of regulation. // "TYPE_LOGICAL_BORDER" - A grouping of TYPE_BORDER features ("border // segments"), which together represent a border between two features of // the same type. @@ -40730,7 +40845,7 @@ type GeostoreInternalSourceSummaryProto struct { // "PROVIDER_GOOGLE" - ABSTRACT // "PROVIDER_GOOGLE_HAND_EDIT" // "PROVIDER_GOOGLE_BORDERS" - All new "Google" provider entries must - // be full ints. The next available ID is: 0x111730AE + // be full ints. The next available ID is: 0x111730B1 // "PROVIDER_GOOGLE_SUBRANGE" - ABSTRACT // "PROVIDER_GOOGLE_GT_FUSION" // "PROVIDER_GOOGLE_ZAGAT_CMS" @@ -40904,6 +41019,9 @@ type GeostoreInternalSourceSummaryProto struct { // "PROVIDER_GOOGLE_GEO_LDE" // "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING" // "PROVIDER_GOOGLE_UGC_AGGREGATION" + // "PROVIDER_GOOGLE_3D_BASEMAP" + // "PROVIDER_GOOGLE_MAPFACTS_PRIVACY" + // "PROVIDER_GOOGLE_GT_ALF" // "PROVIDER_GOOGLE_LOCALSEARCH" - The next new "Google" provider // entries should be placed above. // "PROVIDER_GOOGLE_TRANSIT" - UMBRELLA @@ -41448,7 +41566,8 @@ type GeostoreInternalSourceSummaryProto struct { // "PROVIDER_MASTERCARD" // "PROVIDER_VATTENFALL" // "PROVIDER_VIETGIS" - // "PROVIDER_UNITE" - Note: Next available value is 0x126E. + // "PROVIDER_UNITE" + // "PROVIDER_NEOGY" - Note: Next available value is 0x126F. Provider string `json:"provider,omitempty"` // ForceSendFields is a list of field names (e.g. "Dataset") to @@ -42893,7 +43012,7 @@ type GeostoreOntologyRawGConceptInstanceProto struct { // "PROVIDER_GOOGLE" - ABSTRACT // "PROVIDER_GOOGLE_HAND_EDIT" // "PROVIDER_GOOGLE_BORDERS" - All new "Google" provider entries must - // be full ints. The next available ID is: 0x111730AE + // be full ints. The next available ID is: 0x111730B1 // "PROVIDER_GOOGLE_SUBRANGE" - ABSTRACT // "PROVIDER_GOOGLE_GT_FUSION" // "PROVIDER_GOOGLE_ZAGAT_CMS" @@ -43067,6 +43186,9 @@ type GeostoreOntologyRawGConceptInstanceProto struct { // "PROVIDER_GOOGLE_GEO_LDE" // "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING" // "PROVIDER_GOOGLE_UGC_AGGREGATION" + // "PROVIDER_GOOGLE_3D_BASEMAP" + // "PROVIDER_GOOGLE_MAPFACTS_PRIVACY" + // "PROVIDER_GOOGLE_GT_ALF" // "PROVIDER_GOOGLE_LOCALSEARCH" - The next new "Google" provider // entries should be placed above. // "PROVIDER_GOOGLE_TRANSIT" - UMBRELLA @@ -43611,7 +43733,8 @@ type GeostoreOntologyRawGConceptInstanceProto struct { // "PROVIDER_MASTERCARD" // "PROVIDER_VATTENFALL" // "PROVIDER_VIETGIS" - // "PROVIDER_UNITE" - Note: Next available value is 0x126E. + // "PROVIDER_UNITE" + // "PROVIDER_NEOGY" - Note: Next available value is 0x126F. Provider string `json:"provider,omitempty"` SourceDataset string `json:"sourceDataset,omitempty"` @@ -44930,6 +45053,70 @@ func (s *GeostorePriceInfoProto) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type GeostorePriceInfoSourceDetails struct { + LastUpdateSources []*GeostorePriceInfoSourceDetailsSourceData `json:"lastUpdateSources,omitempty"` + + SourceData []*GeostorePriceInfoSourceDetailsSourceData `json:"sourceData,omitempty"` + + // ForceSendFields is a list of field names (e.g. "LastUpdateSources") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "LastUpdateSources") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GeostorePriceInfoSourceDetails) MarshalJSON() ([]byte, error) { + type NoMethod GeostorePriceInfoSourceDetails + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type GeostorePriceInfoSourceDetailsSourceData struct { + // ClientProjectNumber: Project number of the GMB API client. Set only + // if the source is EXTERNAL_GMB_API. + ClientProjectNumber int64 `json:"clientProjectNumber,omitempty,string"` + + // Possible values: + // "SOURCE_UNSPECIFIED" - No source specified. + // "NMX_UI" - The menu comes from our own UI. + // "EXTERNAL_GMB_API" - The menu comes from a third party. + Source string `json:"source,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ClientProjectNumber") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ClientProjectNumber") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GeostorePriceInfoSourceDetailsSourceData) MarshalJSON() ([]byte, error) { + type NoMethod GeostorePriceInfoSourceDetailsSourceData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GeostorePriceInfoStatus: Providers of PriceInfo (e.g. SinglePlatform, // YEXT) send verified and unverified listings. PriceInfoStatus is used // to encapsulate this information. @@ -45022,6 +45209,10 @@ func (s *GeostorePriceListNameInfoProto) MarshalJSON() ([]byte, error) { // FoodMenuItems defined below. At least one item must be present in // each section. type GeostorePriceListProto struct { + // AggregatorId: For third party lists, represents the ID of the + // aggregator which provided this data. Optional. + AggregatorId uint64 `json:"aggregatorId,omitempty,string"` + // AvailableTime: The time period when this price list is available. // Establishments are not required to give available_time for any given // price list, however, when this field is not set, the price list is @@ -45083,12 +45274,16 @@ type GeostorePriceListProto struct { // all sections contain only the same type of items. Section []*GeostorePriceListSectionProto `json:"section,omitempty"` + // SourceDetails: Source of the information retrieved, could be from our + // own NMX UI or a third party API. + SourceDetails *GeostorePriceInfoSourceDetails `json:"sourceDetails,omitempty"` + // SourceUrl: Where this price list comes from. If set, this must also // be a member of the price_list_url field, and represents translations // of a single URL. SourceUrl *GeostoreUrlListProto `json:"sourceUrl,omitempty"` - // ForceSendFields is a list of field names (e.g. "AvailableTime") to + // ForceSendFields is a list of field names (e.g. "AggregatorId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -45096,7 +45291,7 @@ type GeostorePriceListProto struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AvailableTime") to include + // NullFields is a list of field names (e.g. "AggregatorId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as @@ -45141,7 +45336,11 @@ type GeostorePriceListSectionProto struct { // TYPE_SERVICE is being deprecated. Please use TYPE_JOB for the new // services See b/147253790 for more information. data. // "TYPE_PRODUCT" - For product items (stored in ComposableItemProto). - // "TYPE_JOB" - For jobs (stored in ComposableItemProto). + // "TYPE_JOB" - For "1P" jobs data (stored in ComposableItemProto), + // summarized from a variety of sources such as GMB/NMX, web crawling, + // and Structured Reviews. + // "TYPE_3P_JOB" - For third party jobs data sourced from 3P partner + // feeds, which need to remain separate from the TYPE_JOB list. ItemType []string `json:"itemType,omitempty"` // Media: One or more media items (photos, videos, etc.) describing this @@ -45352,7 +45551,7 @@ type GeostoreProvenanceProto struct { // "PROVIDER_GOOGLE" - ABSTRACT // "PROVIDER_GOOGLE_HAND_EDIT" // "PROVIDER_GOOGLE_BORDERS" - All new "Google" provider entries must - // be full ints. The next available ID is: 0x111730AE + // be full ints. The next available ID is: 0x111730B1 // "PROVIDER_GOOGLE_SUBRANGE" - ABSTRACT // "PROVIDER_GOOGLE_GT_FUSION" // "PROVIDER_GOOGLE_ZAGAT_CMS" @@ -45526,6 +45725,9 @@ type GeostoreProvenanceProto struct { // "PROVIDER_GOOGLE_GEO_LDE" // "PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING" // "PROVIDER_GOOGLE_UGC_AGGREGATION" + // "PROVIDER_GOOGLE_3D_BASEMAP" + // "PROVIDER_GOOGLE_MAPFACTS_PRIVACY" + // "PROVIDER_GOOGLE_GT_ALF" // "PROVIDER_GOOGLE_LOCALSEARCH" - The next new "Google" provider // entries should be placed above. // "PROVIDER_GOOGLE_TRANSIT" - UMBRELLA @@ -46070,7 +46272,8 @@ type GeostoreProvenanceProto struct { // "PROVIDER_MASTERCARD" // "PROVIDER_VATTENFALL" // "PROVIDER_VIETGIS" - // "PROVIDER_UNITE" - Note: Next available value is 0x126E. + // "PROVIDER_UNITE" + // "PROVIDER_NEOGY" - Note: Next available value is 0x126F. Provider string `json:"provider,omitempty"` // ForceSendFields is a list of field names (e.g. "Dataset") to @@ -53872,8 +54075,35 @@ type GoogleCloudContentwarehouseV1DocumentQuery struct { PropertyFilter []*GoogleCloudContentwarehouseV1PropertyFilter `json:"propertyFilter,omitempty"` // Query: The query string that matches against the full text of the - // document and the searchable properties. The maximum number of allowed - // characters is 255. + // document and the searchable properties. The query partially supports + // Google AIP style syntax (https://google.aip.dev/160). Specifically, + // the query supports literals, logical operators, negation operators, + // comparison operators, and functions. Literals: A bare literal value + // (examples: "42", "Hugo") is a value to be matched against. It + // searches over the full text of the document and the searchable + // properties. Logical operators: "AND", "and", "OR", and "or" are + // binary logical operators (example: "engineer OR developer"). Negation + // operators: "NOT" and "!" are negation operators (example: "NOT + // software"). Comparison operators: support the binary comparison + // operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. + // Also support like operator `~~` for string. It provides semantic + // search functionality by parsing, stemming and doing synonyms + // expansion against the input query. To specify a property in the + // query, the left hand side expression in the comparison must be the + // property ID including the parent. The right hand side must be + // literals. For example: "\"projects/123/locations/us\".property_a < 1" + // matches results whose "property_a" is less than 1 in project 123 and + // us location. The literals and comparison expression can be connected + // in a single query (example: "software engineer + // \"projects/123/locations/us\".salary > 100"). Functions: supported + // functions are `LOWER([property_name])` to perform a case insensitive + // match and `EMPTY([property_name])` to filter on the existence of a + // key. Support nested expressions connected using parenthesis and + // logical operators. The default logical operators is `AND` if there is + // no operators between expressions. The query can be used with other + // filters e.g. `time_filters` and `folder_name_filter`. They are + // connected with `AND` operator under the hood. The maximum number of + // allowed characters is 255. Query string `json:"query,omitempty"` // QueryContext: For custom synonyms. Customers provide the synonyms @@ -53975,7 +54205,7 @@ type GoogleCloudContentwarehouseV1DocumentSchema struct { Description string `json:"description,omitempty"` // DisplayName: Required. Name of the schema given by the user. Must be - // unique per customer. + // unique per project. DisplayName string `json:"displayName,omitempty"` // DocumentIsFolder: Document Type, true refers the document is a @@ -55633,7 +55863,10 @@ type GoogleCloudContentwarehouseV1SearchDocumentsRequest struct { // desc": By relevance descending, as determined by the API algorithms. // * "upload_date desc": By upload date descending. * "upload_date": // By upload date ascending. * "update_date desc": By last updated - // date descending. * "update_date": By last updated date ascending. + // date descending. * "update_date": By last updated date ascending. * + // "retrieval_importance desc": By retrieval importance of properties + // descending. This feature is still under development, please do not + // use unless otherwise instructed to do so. OrderBy string `json:"orderBy,omitempty"` // PageSize: A limit on the number of documents returned in the search @@ -56563,7 +56796,7 @@ type GoogleCloudDocumentaiV1Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -56712,12 +56945,12 @@ type GoogleCloudDocumentaiV1DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -56939,8 +57172,8 @@ type GoogleCloudDocumentaiV1DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -57182,7 +57415,8 @@ type GoogleCloudDocumentaiV1DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -58613,6 +58847,18 @@ func (s *GoogleInternalAppsWaldoV1alphaAvailabilityPeriod) MarshalJSON() ([]byte // user is temporarily busy and there is not a more specific status // derived from calendar that applies (e.g., InMeeting or DoNotDisturb). type GoogleInternalAppsWaldoV1alphaCalendarBusy struct { + // CommittedUntil: The time when the user will stop being committed, + // i.e., when their status will be neither of InMeeting, DoNotDisturb, + // Busy or OutOfOffice < Xh. Note that the goal of this field is to + // provide information to help users decide how to communicate with a + // user (see also http://shortn/_wXYXtZScgh). + CommittedUntil string `json:"committedUntil,omitempty"` + + // CommittedUntilIsMixed: Whether the status of the user from this + // status's start to committed_until has more than one status type (e.g. + // DoNotDisturb + InMeeting). + CommittedUntilIsMixed bool `json:"committedUntilIsMixed,omitempty"` + // EventSummary: The summary of the corresponding event in Calendar. EventSummary string `json:"eventSummary,omitempty"` @@ -58625,7 +58871,7 @@ type GoogleInternalAppsWaldoV1alphaCalendarBusy struct { // when their status will be neither inMeeting, Busy nor DoNotDisturb. OccupiedUntil string `json:"occupiedUntil,omitempty"` - // ForceSendFields is a list of field names (e.g. "EventSummary") to + // ForceSendFields is a list of field names (e.g. "CommittedUntil") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -58633,12 +58879,13 @@ type GoogleInternalAppsWaldoV1alphaCalendarBusy struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "EventSummary") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "CommittedUntil") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -58689,8 +58936,8 @@ func (s *GoogleInternalAppsWaldoV1alphaCustomLocation) MarshalJSON() ([]byte, er // user should not be disturbed. type GoogleInternalAppsWaldoV1alphaDoNotDisturb struct { // CommittedUntil: The time when the user will stop being committed, - // i.e., when their status will be neither of InMeeting, DoNotDisturb or - // OutOfOffice < Xh. + // i.e., when their status will be neither of InMeeting, DoNotDisturb, + // Busy or OutOfOffice < Xh. CommittedUntil string `json:"committedUntil,omitempty"` // CommittedUntilIsMixed: Whether the status of the user from this @@ -58739,10 +58986,10 @@ type GoogleInternalAppsWaldoV1alphaHomeLocation struct { // user is in a meeting. type GoogleInternalAppsWaldoV1alphaInMeeting struct { // CommittedUntil: The time when the user will stop being committed, - // i.e., when their status will be neither of InMeeting, DoNotDisturb or - // OutOfOffice < Xh. Note that the goal of this field is to provide - // information to help users decide how to communicate with a user (see - // also http://shortn/_wXYXtZScgh). + // i.e., when their status will be neither of InMeeting, DoNotDisturb, + // Busy or OutOfOffice < Xh. Note that the goal of this field is to + // provide information to help users decide how to communicate with a + // user (see also http://shortn/_wXYXtZScgh). CommittedUntil string `json:"committedUntil,omitempty"` // CommittedUntilIsMixed: Whether the status of the user from this @@ -58876,15 +59123,14 @@ type GoogleInternalAppsWaldoV1alphaOutOfOffice struct { ComeBackTime string `json:"comeBackTime,omitempty"` // CommittedUntil: The time when the user will stop being committed, - // i.e., when their status will be neither of InMeeting, DoNotDisturb or - // OutOfOffice < Xh. Note that if this OOO block is large (>Xh), - // committed_until will be the end of this block, not including any - // meetings or focus time following it. + // i.e., when their status will be neither of InMeeting, DoNotDisturb, + // Busy or OutOfOffice < Xh. Note that if this OOO block is large + // (>=Xh), committed_until is not set. CommittedUntil string `json:"committedUntil,omitempty"` // CommittedUntilIsMixed: Whether the status of the user from this // status's start to committed_until has more than one status type (e.g. - // DoNotDisturb + InMeeting). + // DoNotDisturb + InMeeting). Only set if committed_until is set. CommittedUntilIsMixed bool `json:"committedUntilIsMixed,omitempty"` // EventSummary: The summary of the corresponding OOO block in Calendar. @@ -58979,15 +59225,15 @@ func (s *GoogleInternalAppsWaldoV1alphaTimeRange) MarshalJSON() ([]byte, error) } type GoogleInternalAppsWaldoV1alphaUpcomingCommitmentContext struct { - // NextCommitmentStatus: The status type of the commitment above. The - // status will be an empty instance of the corresponding type, no - // additional data will be provided. + // NextCommitmentStatus: The status of the commitment above. NextCommitmentStatus *GoogleInternalAppsWaldoV1alphaUserStatus `json:"nextCommitmentStatus,omitempty"` // NextCommitmentTime: The most relevant upcoming commitment (InMeeting, - // DoNotDisturb or OutOfOffice). In most cases this will be the next - // closest commitment event, but if there is a large OOO in less than - // 24h it will take precedence over earlier events. + // DoNotDisturb, CalendarBusy or OutOfOffice). This context is set only + // if there is an upcoming commitment to show, and only on non + // commitments. Priority is given to the next closest commitment if its + // start is close enough to this event, otherwise the next large OOO if + // there is one. NextCommitmentTime string `json:"nextCommitmentTime,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -61445,6 +61691,8 @@ type HtmlrenderWebkitHeadlessProtoReferencedResource struct { // RenderResponse. ReferencedResourceContentIndex int64 `json:"referencedResourceContentIndex,omitempty"` + // RequestHeader: Only necessary headers are recorded. See + // google3/htmlrender/webkit_headless/resource_key.cc RequestHeader []*HtmlrenderWebkitHeadlessProtoReferencedResourceHttpHeader `json:"requestHeader,omitempty"` // RequestMethod: The HTTP request method (GET, HEAD, POST, etc) used @@ -61984,6 +62232,9 @@ type HtmlrenderWebkitHeadlessProtoResource struct { PostData string `json:"postData,omitempty"` + // RequestHeader: Only necessary headers are included in the resource + // key by default. See + // google3/htmlrender/webkit_headless/resource_key.cc RequestHeader []*HtmlrenderWebkitHeadlessProtoResourceHttpHeader `json:"requestHeader,omitempty"` Url string `json:"url,omitempty"` @@ -62913,6 +63164,10 @@ type ImageBaseVideoPreviewMetadata struct { // LINT.ThenChange( // //depot/google3/video/pipeline/graph/sequences/mp4_moving_thumbnail.go // ) + // "VPREVIEW_TYPE_VIDEO_ANSWER_300K_15SEC" - Video Answer previews + // (640x360, 10fps). See go/vsva-le1-doc and go/vsva-serving-design for + // the details. previews up to 15 seconds + // "VPREVIEW_TYPE_VIDEO_ANSWER_300K_6SEC" - previews up to 6 seconds // "VPREVIEW_TENOR_250K_PREVIEW" - LINT.IfChange Tenor VPREIVEW is // added by cl/237845543 (billzeng) This corresponds to 498*498, max // 18fps. Preview for Tenor only. @@ -62955,9 +63210,7 @@ type ImageBaseVideoPreviewMetadata struct { // "VPREVIEW_TENOR_100K_FIXED_200W_MP4" - This corresponds to 200*498, // max 10fps. Preview for Tenor only. LINT.ThenChange( // //depot/google3/image/tenor/eleven/util/format_helpers.cc, - // //depot/google3/image/tenor/eleven/util/format_helpers_test.cc, - // //depot/google3/image/tenor/ps1/plugin/data_processing/service/util/tr - // anscode_type_translator.cc:preview_type_map, ) + // //depot/google3/image/tenor/eleven/util/format_helpers_test.cc, ) Type string `json:"type,omitempty"` // Width: Width of the stored preview. @@ -65231,6 +65484,7 @@ type ImageRepositoryApiItagSpecificMetadata struct { // genera. go/user-owned-video-content-processing // "GENUS_CONTRIB_SERVICE_GEO_UGC" - Genus for GEO UGC videos // processed by ContribService. go/venom-lite-for-geo-photo-videos + // "GENUS_SEARCH_SPORTS" - Genus for Search Sports vertical videos Genus string `json:"genus,omitempty"` // State: Indicates the state in Venom for this transcode type. @@ -66490,6 +66744,7 @@ type ImageRepositoryVenomStatus struct { // genera. go/user-owned-video-content-processing // "GENUS_CONTRIB_SERVICE_GEO_UGC" - Genus for GEO UGC videos // processed by ContribService. go/venom-lite-for-geo-photo-videos + // "GENUS_SEARCH_SPORTS" - Genus for Search Sports vertical videos Genus string `json:"genus,omitempty"` // InsertionResponseTimestampUsec: Time that VideoNotification result @@ -69109,10 +69364,12 @@ func (s *IndexingDocjoinerCDocBuildInfo) MarshalJSON() ([]byte, error) { type IndexingDocjoinerDataVersion struct { AcceleratedShoppingSignal *IndexingDocjoinerDataVersionVersionInfo `json:"acceleratedShoppingSignal,omitempty"` - // ChromeCounts: + ChromeCounts *IndexingDocjoinerDataVersionVersionInfo `json:"chromeCounts,omitempty"` + + // InstantNavboost: // LINT.ThenChange(//depot/google3/indexing/ames/spanner/schema/websearch // _main.sdl) - ChromeCounts *IndexingDocjoinerDataVersionVersionInfo `json:"chromeCounts,omitempty"` + InstantNavboost *IndexingDocjoinerDataVersionVersionInfo `json:"instantNavboost,omitempty"` Localyp *IndexingDocjoinerDataVersionVersionInfo `json:"localyp,omitempty"` @@ -73740,6 +73997,8 @@ type KnowledgeAnswersIntentQueryArgumentProvenanceCurrentQuery struct { // below, populating it's eval-data fields accordingly. EvalData []*NlpSemanticParsingAnnotationEvalData `json:"evalData,omitempty"` + NeuralLocationAnnotator *KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator `json:"neuralLocationAnnotator,omitempty"` + // ForceSendFields is a list of field names (e.g. "EvalData") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -73776,6 +74035,13 @@ func (s *KnowledgeAnswersIntentQueryArgumentProvenanceCurrentQuery) MarshalJSON( type KnowledgeAnswersIntentQueryArgumentProvenanceInjectedContextualSchema struct { } +// KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator: +// The value is used for CurrentQuery.annotator and +// PreviousQuery.annotator to indicate what annotator annotated the +// argument +type KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator struct { +} + // KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery: The value // is carried over from either the previous winning IntentQuery or an // entity annotated by QRef in a previous query. For example: U: How old @@ -73799,6 +74065,8 @@ type KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery struct { // EventId: The event ID of the query where this value was pulled from. EventId *EventIdMessage `json:"eventId,omitempty"` + NeuralLocationAnnotator *KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator `json:"neuralLocationAnnotator,omitempty"` + Role *KnowledgeAnswersIntentQueryArgumentProvenancePreviousQueryRole `json:"role,omitempty"` // Possible values: @@ -80936,8 +81204,15 @@ func (s *MajelContactInformationShortcutInformation) MarshalJSON() ([]byte, erro // about a special word. If you add another flag please add it to the // special words implemenation in // google3/maps/quality/internal/special_words.cc. -- Next available id: -// 21 -- +// 22 -- type MapsQualitySpecialWordsFlags struct { + // IsAlleyAffix: An affix that indicates an alley. Alleys are unnamed, + // numbered routes that are always linked to a "parent street". As these + // parent streets can be named e.g. "7th street" and alleys might be + // referred to as "7th alley", we need to be able to distinguish those + // affixes. For more details about alleys see go/vn-alley-geocoding. + IsAlleyAffix bool `json:"isAlleyAffix,omitempty"` + // IsCommonWord: Common words E.g.: center, park, etc. IsCommonWord bool `json:"isCommonWord,omitempty"` @@ -81010,7 +81285,7 @@ type MapsQualitySpecialWordsFlags struct { // e.g. "number", "unit" etc. IsStreetNumberIdentifier bool `json:"isStreetNumberIdentifier,omitempty"` - // ForceSendFields is a list of field names (e.g. "IsCommonWord") to + // ForceSendFields is a list of field names (e.g. "IsAlleyAffix") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -81018,7 +81293,7 @@ type MapsQualitySpecialWordsFlags struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "IsCommonWord") to include + // NullFields is a list of field names (e.g. "IsAlleyAffix") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as @@ -82183,238 +82458,6 @@ func (s *NetFabricRpcVirtualNetworkId) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// NewsReconServiceLrsQ2lrs2EntryPayload: Next ID: 7 -type NewsReconServiceLrsQ2lrs2EntryPayload struct { - IsDailyMoment bool `json:"isDailyMoment,omitempty"` - - // IsMomentAnyFlavor: DEPRECATED as in: will be removed shortly. - IsMomentAnyFlavor bool `json:"isMomentAnyFlavor,omitempty"` - - IsPlannedMoment bool `json:"isPlannedMoment,omitempty"` - - // LrsTypes: This is meant to hold `LongRunningStory.Type`s only, - // unfortunately adding an import here causes a circular dependency. - LrsTypes []int64 `json:"lrsTypes,omitempty"` - - MomentRankingScore int64 `json:"momentRankingScore,omitempty,string"` - - // OutKgFeatureTypes: LRS-level feature types to be sent as triples to - // KG. The equivalent KG collection will be added to the LRS topic. - OutKgFeatureTypes []string `json:"outKgFeatureTypes,omitempty"` - - // ForceSendFields is a list of field names (e.g. "IsDailyMoment") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "IsDailyMoment") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *NewsReconServiceLrsQ2lrs2EntryPayload) MarshalJSON() ([]byte, error) { - type NoMethod NewsReconServiceLrsQ2lrs2EntryPayload - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -type NewsReconServiceLrsQ2lrs2QueryToLrsDataset struct { - // Entries: At most one entry per (LRS, algo version) pair. - Entries []*NewsReconServiceLrsQ2lrs2QueryToLrsEntry `json:"entries,omitempty"` - - TimeMillis int64 `json:"timeMillis,omitempty,string"` - - // ForceSendFields is a list of field names (e.g. "Entries") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Entries") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *NewsReconServiceLrsQ2lrs2QueryToLrsDataset) MarshalJSON() ([]byte, error) { - type NoMethod NewsReconServiceLrsQ2lrs2QueryToLrsDataset - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// NewsReconServiceLrsQ2lrs2QueryToLrsEntry: Each entry is specific to -// one LRS, and contains all the information required for matching a -// query with the LRS. For example: entries { lrs { mid: -// "/m/2024WakandaSenateElection" } qref_entities { mid: "/m/election" # -// The general concept of election debug_index: 0 } qref_entities { mid: -// "/m/senate" debug_index: 1 } qref_entities { mid: "/m/wakanda" -// debug_index: 2 } qref_entities { mid: "/m/WakandaSenate" debug_index: -// 3 } qref_entities { mid: "/m/2024" # The year 2024 debug_index: 4 } -// patterns { pattern: "TT***" only_in { regions: "WK" # BCP-47 region -// code for Wakanda } } patterns { pattern: "TTT**" } patterns { -// pattern: "T**T*" } algo_version: 7 } The characters in every pattern -// string match the `qref_entities` pairwise. For example, in the -// pattern "TT***", the first T corresponds to the entity /m/election, -// the second T to /m/senate, the first star to /m/wakanda. A query -// matches a pattern if all the entities marked as T (== required) are -// found by QRef. If QRef also finds entities marked as star (== -// optional), those entities will be consumed in the LRS interpretation -// and added to the `QueryToLrsInterpretation.consumed_qref_mids` field. -// A query matches an entry if either: - QRef found the LRS entity -// itself in the query. This is the best-case scenario, it happens when -// the name of the event is well defined (for example "brexit") and the -// query mentions it explicitly; - the query matches any of the patterns -// defined in the entry. Next id: 8 -type NewsReconServiceLrsQ2lrs2QueryToLrsEntry struct { - // AlgoVersion: The value of a `AlgoVersion.Enum` constant. - AlgoVersion int64 `json:"algoVersion,omitempty"` - - // EntryIndex: Index of the entry in the list of entries. This does not - // need to be populated in the dataset which is written to disk. - EntryIndex int64 `json:"entryIndex,omitempty"` - - InternalPayload *NewsReconServiceLrsQ2lrs2EntryPayload `json:"internalPayload,omitempty"` - - Lrs *NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity `json:"lrs,omitempty"` - - Patterns []*NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern `json:"patterns,omitempty"` - - QrefEntities []*NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity `json:"qrefEntities,omitempty"` - - // ForceSendFields is a list of field names (e.g. "AlgoVersion") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "AlgoVersion") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *NewsReconServiceLrsQ2lrs2QueryToLrsEntry) MarshalJSON() ([]byte, error) { - type NoMethod NewsReconServiceLrsQ2lrs2QueryToLrsEntry - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity: Next id: 7 -type NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity struct { - DebugIndex int64 `json:"debugIndex,omitempty"` - - DebugName string `json:"debugName,omitempty"` - - // EncodedMid: This does not need to be populated in the dataset which - // is written to disk. - EncodedMid uint64 `json:"encodedMid,omitempty,string"` - - Mid string `json:"mid,omitempty"` - - // ForceSendFields is a list of field names (e.g. "DebugIndex") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "DebugIndex") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity) MarshalJSON() ([]byte, error) { - type NoMethod NewsReconServiceLrsQ2lrs2QueryToLrsEntryEntity - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict: A locale -// satisfies the restrict if there is any match. -type NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict struct { - // Regions: BCP-47 region codes, e.g. "US". There is a match if the - // user's locale `.region_subtag()` is found in this set, e.g. the - // user's locale is "es-US". - Regions []string `json:"regions,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Regions") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Regions") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict) MarshalJSON() ([]byte, error) { - type NoMethod NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -type NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern struct { - // OnlyIn: If set, the pattern only applies if the locale satisifes the - // restrict. - OnlyIn *NewsReconServiceLrsQ2lrs2QueryToLrsEntryLocaleRestrict `json:"onlyIn,omitempty"` - - // Pattern: A string containing N characters, where each character is - // 'T' (required) or '*' (optional), and N is the size of - // `qref_entities`. Characters match QRef entities pairwise. - Pattern string `json:"pattern,omitempty"` - - // ForceSendFields is a list of field names (e.g. "OnlyIn") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "OnlyIn") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern) MarshalJSON() ([]byte, error) { - type NoMethod NewsReconServiceLrsQ2lrs2QueryToLrsEntryPattern - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // NlpLoggingQRewriteClientCallPathInfo: The proto that holds the // complete call path info of the QRewrite client (e.g. the QUS's phase // like "RBT","QBT"; the QUS's candidate type like "Identity"; and the @@ -97282,8 +97325,8 @@ type PeoplestackFlexorgsProtoInternalExternal struct { // paisa-eng@google.com // "SANDCLOCK" - SandClock app http://go/sandclock Team contact: // sandclock-eng@google.com - // "ACCOUNT_SETTINGS_MOBILE" - Account Settings Mobile http://go/asm - // Team contact: myaccount-mobile-eng@google.com + // "ACCOUNT_SETTINGS_MOBILE" - My Google Account http://go/my-google + // Team contact: my-google-eng@google.com // "GOOGLE_VOICE" - The telephony application! Contact voice-team@ or // voice-fe@ // "WING_MARKETPLACE" - Wing Marketplace http://go/xwma Team contact: @@ -97673,6 +97716,13 @@ type PeoplestackFlexorgsProtoInternalExternal struct { // gpay-release-ops@google.com // "SKILLSSTACK" - Skillsstack Team contact: // "WHOSTORY" - Whostory Team contact: whostory@google.com + // "BETTANY" - Bettany Team contact: bettany-eng@google.com + // "BASECAMP" - Basecamp Team contact: hardware-ml-infra@google.com + // "CULTURE_EVENTS_CALENDAR" - CULTURE_EVENTS_CALENDAR Team contact: + // culture-events-calendar@google.com + // "DATABRIDGE_CONSOLE" - Databridge Console Team contact: + // databrige-eng@google.com + // "COMMSTAR" - Commstar Team contact: mdb.commstar-dev@google.com // "DEPRECATED_QUICKSTART_FLUME" // "DUO_CLIENT" - Duo Client Team contact: duo-eng@google.com // "ALBERT" - Project albert (go/albert-frontend) Team contact: @@ -98185,7 +98235,7 @@ func (s *PeoplestackFlexorgsProtoInternalExternalStateStatus) MarshalJSON() ([]b // fo} for protocols used during search and/or docinfo. Next available // tag deprecated, use this (and look for commented out fields): // blaze-bin/net/proto_compiler/protocol-compiler --freetags \ -// indexer/perdocdata/perdocdata.proto Next tag: 218 +// indexer/perdocdata/perdocdata.proto Next tag: 219 type PerDocData struct { BlogData *BlogPerDocData `json:"BlogData,omitempty"` @@ -98277,9 +98327,6 @@ type PerDocData struct { // going from 0 to 127. ScaledSpamScoreYoram int64 `json:"ScaledSpamScoreYoram,omitempty"` - // ScienceData: science data - used only in scholar index - ScienceData *SciencePerDocData `json:"ScienceData,omitempty"` - // SpamWordScore: The spamword score is represented in 7-bits, going // from 0 to 127. SpamWordScore int64 `json:"SpamWordScore,omitempty"` @@ -98629,6 +98676,9 @@ type PerDocData struct { // on muppet side. SpamMuppetSignals *SpamMuppetjoinsMuppetSignals `json:"spamMuppetSignals,omitempty"` + // SpambrainData: Site level scores coming from spambrain. + SpambrainData *SpamBrainData `json:"spambrainData,omitempty"` + // SpambrainTotalDocSpamScore: The document total spam score identified // by spambrain, going from 0 to 1. SpambrainTotalDocSpamScore float64 `json:"spambrainTotalDocSpamScore,omitempty"` @@ -99500,8 +99550,10 @@ type PersonalizationMapsAliasIcon struct { // for a user to meet a taxi, ridesharing vehicle, or general driver. // "TYPE_REGULATED_AREA" - An area controlled in some way by an // authoritative source, such as a government-designated COVID - // containment zone. Features of this type should have one or more gcids - // corresponding to their specific regulation. + // containment zone or an area under government sanctions. Features of + // this type should have one or more gcids corresponding to their + // specific regulation, and client handling of these features may vary + // based on the type of regulation. // "TYPE_LOGICAL_BORDER" - A grouping of TYPE_BORDER features ("border // segments"), which together represent a border between two features of // the same type. @@ -103672,7 +103724,8 @@ type QualityCalypsoAppsUniversalAuLiveOpDetail struct { // "CROSSOVER" - Crossover, also known as IP collaboration in JP - // This is an event involving a collaboration IP. // "PRE_REG_UPDATE" - Pre-registration update - announcement for - // pre-reg apps. + // pre-reg apps. Note that this maps to a subtype of Major Update in the + // Play Console UI. // "LOYALTY" - Loyalty LiveOps event. E.g. special points earn // promotion etc. // "FIRST_PARTY_PROMOTION" - First party promotions funded by Play. @@ -103837,6 +103890,66 @@ func (s *QualityCalypsoAppsUniversalAuLiveOpsDetailInfo) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type QualityCalypsoAppsUniversalImage struct { + FifeUrl string `json:"fifeUrl,omitempty"` + + Height int64 `json:"height,omitempty"` + + Width int64 `json:"width,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FifeUrl") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FifeUrl") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *QualityCalypsoAppsUniversalImage) MarshalJSON() ([]byte, error) { + type NoMethod QualityCalypsoAppsUniversalImage + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type QualityCalypsoAppsUniversalImageData struct { + // FeatureGraphic: aka. promotional image / cover image. + FeatureGraphic *QualityCalypsoAppsUniversalImage `json:"featureGraphic,omitempty"` + + Screenshot []*QualityCalypsoAppsUniversalImage `json:"screenshot,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FeatureGraphic") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FeatureGraphic") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *QualityCalypsoAppsUniversalImageData) MarshalJSON() ([]byte, error) { + type NoMethod QualityCalypsoAppsUniversalImageData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // QualityCopiaFireflySiteSignal: Proto message containing site-level // signal for search stack. Because firefly_stats.proto depends on // "//segindexer:compositedoc_proto", we cannot make perdocdata contain @@ -106025,30 +106138,56 @@ func (s *QualityNsrNsrDataClusterUplift) UnmarshalJSON(data []byte) error { } // QualityNsrNsrDataMetadata: Contains meta information about this data. +// This field is only available in docjoins (and potentially MDU +// shards), it is not populated offline. NOTE: This is a new field (Nov +// 2022) and we do not want clients to depend on this; please contact +// qscore-team@ if you want to use this information. type QualityNsrNsrDataMetadata struct { - // RaffiaLookupKey: This is an internal field set by Raffia, to indicate - // which lookup key this record belonged to. This is helpful in - // determining where the final data is coming from, as we don't populate - // `site_chunk` fields offline (at all), so we cannot distinguish if - // data is coming from host fallback, secondary chunks or something - // else. + // GoldmineLookupKeyPerField: Same as raffia_lookup_key_per_field. Note + // that the goldmine_lookups have priority; if a field appears in both + // goldmine and raffia entries, it means it was taken from goldmine. If + // it's missing here but present in raffia_lookup_key_per_field, it was + // taken from raffia. + GoldmineLookupKeyPerField map[string]int64 `json:"goldmineLookupKeyPerField,omitempty"` + + // GoldmineLookupKeys: The lookup keys attempted by goldmine. Note that + // goldmine only runs for urls which can be chunked differently than + // raffia; in those cases, goldmine related fields are empty. + GoldmineLookupKeys []string `json:"goldmineLookupKeys,omitempty"` + RaffiaLookupKey string `json:"raffiaLookupKey,omitempty"` - // ForceSendFields is a list of field names (e.g. "RaffiaLookupKey") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. + // RaffiaLookupKeyPerField: Returns the raffia lookup key per each field + // in the NsrData proto (with exclusion of the Metadata sub-message + // (i.e. this)). It contains information like 3 : 1, meaning that the + // field inside NsrData with id '3' (in this case 'host') has been taken + // by raffia from the raffia lookup key at index 1. + RaffiaLookupKeyPerField map[string]int64 `json:"raffiaLookupKeyPerField,omitempty"` + + // RaffiaLookupKeys: This is an internal field set by Raffia, to + // indicate which lookup keys have been attempted to populate the + // NsrData for this document. This will allow us to determine which key + // has been used to populate each field in the proto. The keys are + // ordered by lookup priority; raffia will give priority to earlier + // keys, and only take fields from later keys if they are missing. + RaffiaLookupKeys []string `json:"raffiaLookupKeys,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "GoldmineLookupKeyPerField") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "RaffiaLookupKey") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. + // "GoldmineLookupKeyPerField") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. NullFields []string `json:"-"` } @@ -110468,6 +110607,10 @@ func (s *QualitySitemapTwoLevelTarget) MarshalJSON() ([]byte, error) { } type QualityTimebasedLastSignificantUpdate struct { + // AdjustmentInfo: This is stored only for debugging purposes. Please + // consult dates@ team before making a dependency on this field. + AdjustmentInfo *QualityTimebasedLastSignificantUpdateAdjustments `json:"adjustmentInfo,omitempty"` + // Date: LastSignificantUpdate as UNIX timestamp in seconds. This is the // new signal (go/lsu-dd) from LSU Selector V2 (once that is enabled, // see b/171879888 for status), falling back to the legacy V1 signal if @@ -110502,7 +110645,7 @@ type QualityTimebasedLastSignificantUpdate struct { // "LSU_MEDIUM_PRECISION_FRESH_SALIENT_ANNOTATION_FULL_SUPPORT" Source string `json:"source,omitempty"` - // ForceSendFields is a list of field names (e.g. "Date") to + // ForceSendFields is a list of field names (e.g. "AdjustmentInfo") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -110510,12 +110653,13 @@ type QualityTimebasedLastSignificantUpdate struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Date") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "AdjustmentInfo") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -110525,6 +110669,53 @@ func (s *QualityTimebasedLastSignificantUpdate) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type QualityTimebasedLastSignificantUpdateAdjustments struct { + // Possible values: + // "UNSET" + // "PASSAGE_TIMESTAMP" + // "FIRSTSEEN" + // "CONTENT_AGE" + AdjustmentSource string `json:"adjustmentSource,omitempty"` + + // IsUpperboundTimestampPrecise: The timestamp is precise when it's + // derived from existing (>March 2022) passage timestamp. + IsUpperboundTimestampPrecise bool `json:"isUpperboundTimestampPrecise,omitempty"` + + // UnadjustedTimestampInSeconds: The timestamp that was picked up by the + // component indicated in the LastSignificantUpdateSource but was + // dropped due to exceeding the upper bound. The two following fields + // are present only when the adjustment took place. + UnadjustedTimestampInSeconds int64 `json:"unadjustedTimestampInSeconds,omitempty,string"` + + // UpperboundTimestampInSeconds: The upperbound value derived from + // passage timestamps. If present, the LSU date should never exceed this + // value. Design doc: go/lsu-max-passage-timestamp + UpperboundTimestampInSeconds int64 `json:"upperboundTimestampInSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "AdjustmentSource") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AdjustmentSource") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *QualityTimebasedLastSignificantUpdateAdjustments) MarshalJSON() ([]byte, error) { + type NoMethod QualityTimebasedLastSignificantUpdateAdjustments + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + type QualityTimebasedOldnessInfo struct { // IsOldPage: Set to true if this page is considered old. IsOldPage bool `json:"isOldPage,omitempty"` @@ -111734,7 +111925,7 @@ func (s *RepositoryAnnotationsRdfaCrumb) MarshalJSON() ([]byte, error) { } // RepositoryAnnotationsRdfaRdfaRichSnippetsApplication: This structure -// holds data for application information for rich snippets Next ID: 51 +// holds data for application information for rich snippets Next ID: 52 type RepositoryAnnotationsRdfaRdfaRichSnippetsApplication struct { AppTypeData *RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationAppTypeData `json:"appTypeData,omitempty"` @@ -111782,6 +111973,10 @@ type RepositoryAnnotationsRdfaRdfaRichSnippetsApplication struct { IconUrlThumbnail string `json:"iconUrlThumbnail,omitempty"` + // ImageData: Copied from + // google3/contentads/shared/boulder/mobile-app-data-image-data.proto. + ImageData *QualityCalypsoAppsUniversalImageData `json:"imageData,omitempty"` + // InAppPurchase: Whether the app offers in-app purchase. InAppPurchase bool `json:"inAppPurchase,omitempty"` @@ -111848,6 +112043,8 @@ type RepositoryAnnotationsRdfaRdfaRichSnippetsApplication struct { ReviewCount string `json:"reviewCount,omitempty"` + // ScreenUrlHref: TODO(b/260128276) deprecate this field in favor of + // image_data. ScreenUrlHref []string `json:"screenUrlHref,omitempty"` ScreenUrlThumbnail []string `json:"screenUrlThumbnail,omitempty"` @@ -114214,8 +114411,6 @@ type RepositoryWebrefEntityJoin struct { // the model. NameInfo []*RepositoryWebrefGlobalNameInfo `json:"nameInfo,omitempty"` - NameSignals *RepositoryWebrefPreprocessingNameSignals `json:"nameSignals,omitempty"` - // RefconNameInfo: Contains names and names metadata used by Refcon. RefconNameInfo []*RepositoryWebrefRefconRefconNameInfo `json:"refconNameInfo,omitempty"` @@ -116062,6 +116257,7 @@ type RepositoryWebrefLightweightTokensMatchedLightweightToken struct { // "NEGATIVE_SUPERLATIVE" // "FACET_AUDIENCE" - Facets. // "FACET_PURPOSE" + // "SUPERLATIVE" Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -116430,8 +116626,6 @@ type RepositoryWebrefMdvcMetadata struct { // PerVertical: Data, specific to particular verticals. PerVertical []*RepositoryWebrefMdvcMetadataPerVertical `json:"perVertical,omitempty"` - QueryToLongRunningStoryDataset *NewsReconServiceLrsQ2lrs2QueryToLrsDataset `json:"queryToLongRunningStoryDataset,omitempty"` - // ResolutionPriority: Undergoing migration into the PerVertical // message. Avoid using it. Resolution priority for this entity. In case // a query has many possible resolutions, only the ones with the highest @@ -117038,8 +117232,6 @@ type RepositoryWebrefMentionRatingsSingleMentionRating struct { // "RATING_SOURCE_EWOK" // "RATING_SOURCE_SAFT_GOLDEN" // "RATING_SOURCE_CROWDCOMPUTE" - // "RATING_SOURCE_CROWDCOMPUTE_RERATING" - // "RATING_SOURCE_GOLDEN" - Ratings by WebRef engineers. RatingSource string `json:"ratingSource,omitempty"` ResultCount int64 `json:"resultCount,omitempty"` @@ -117527,12 +117719,6 @@ type RepositoryWebrefPerDocRelevanceRating struct { // "VITAL" ContentRelevant string `json:"contentRelevant,omitempty"` - DeprecatedItemId int64 `json:"deprecatedItemId,omitempty"` - - DeprecatedProjectId int64 `json:"deprecatedProjectId,omitempty"` - - DeprecatedTaskId int64 `json:"deprecatedTaskId,omitempty"` - // DisplayString: How this rating is displayed in the evals, // pre-computed from the other fields. DisplayString string `json:"displayString,omitempty"` @@ -117542,12 +117728,8 @@ type RepositoryWebrefPerDocRelevanceRating struct { // https://furball.corp.google.com/project/view-item?itemId=1&projectId=2 FurballUrl string `json:"furballUrl,omitempty"` - ItemDescription string `json:"itemDescription,omitempty"` - ItemId uint64 `json:"itemId,omitempty,string"` - Language string `json:"language,omitempty"` - // PageIsAboutChain: If the topic is about a business chain, whether the // // Possible values: @@ -117559,30 +117741,17 @@ type RepositoryWebrefPerDocRelevanceRating struct { // "DIFFERENT_LOCATION_OF_TOPIC_CHAIN" PageIsAboutChain string `json:"pageIsAboutChain,omitempty"` - // PageNotLoaded: If true, content_relevance is set to NONE. - PageNotLoaded bool `json:"pageNotLoaded,omitempty"` - + // ProjectId: Metadata for task-level ratings. Not filled for aggregated + // doc-level ratings. ProjectId uint64 `json:"projectId,omitempty,string"` // RaterCanUnderstandTopic: Whether rater can understand the topic. RaterCanUnderstandTopic bool `json:"raterCanUnderstandTopic,omitempty"` - // RatingScore: Floating point representation of the `content_relevant` - // field. - RatingScore float64 `json:"ratingScore,omitempty"` - TaskDetails *RepositoryWebrefTaskDetails `json:"taskDetails,omitempty"` TaskId uint64 `json:"taskId,omitempty,string"` - TaskStatus string `json:"taskStatus,omitempty"` - - TaskUser int64 `json:"taskUser,omitempty"` - - // TemplateId: Metadata for task-level ratings. Not filled for - // aggregated doc-level ratings. - TemplateId int64 `json:"templateId,omitempty"` - // TopicIsChain: Whether the topic is about a business chain. // // Possible values: @@ -117617,20 +117786,6 @@ func (s *RepositoryWebrefPerDocRelevanceRating) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -func (s *RepositoryWebrefPerDocRelevanceRating) UnmarshalJSON(data []byte) error { - type NoMethod RepositoryWebrefPerDocRelevanceRating - var s1 struct { - RatingScore gensupport.JSONFloat64 `json:"ratingScore"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.RatingScore = float64(s1.RatingScore) - return nil -} - // RepositoryWebrefPerDocRelevanceRatings: Aggregates ratings by // url/doc_fp. type RepositoryWebrefPerDocRelevanceRatings struct { @@ -117640,16 +117795,10 @@ type RepositoryWebrefPerDocRelevanceRatings struct { // QueryJoin in which the mention rating task has been embedded. - DocFp uint64 `json:"docFp,omitempty,string"` - DocLevelRating *RepositoryWebrefPerDocRelevanceRating `json:"docLevelRating,omitempty"` - EntityNameRating []*RepositoryWebrefEntityNameRatings `json:"entityNameRating,omitempty"` - ListMembership []*RepositoryWebrefToprefListMembership `json:"listMembership,omitempty"` - MentionRating []*RepositoryWebrefMentionRatings `json:"mentionRating,omitempty"` - PageClassification []*RepositoryWebrefToprefPageClassification `json:"pageClassification,omitempty"` - TaskLevelRating []*RepositoryWebrefPerDocRelevanceRating `json:"taskLevelRating,omitempty"` // Url: - In topicality ratings this is the url of the document. - In @@ -117951,69 +118100,6 @@ func (s *RepositoryWebrefPreprocessingNameEntityScores) UnmarshalJSON(data []byt return nil } -// RepositoryWebrefPreprocessingNameSignals: If you add any field, make -// sure to add it in reffresh to the empty checks at the end of the -// corresponding name extractor processors (extract-*-names.cc). -type RepositoryWebrefPreprocessingNameSignals struct { - // NormalizedNameData: The set of name candidates and their signals for - // a given entity. - NormalizedNameData []*RepositoryWebrefPreprocessingNormalizedNameData `json:"normalizedNameData,omitempty"` - - // ForceSendFields is a list of field names (e.g. "NormalizedNameData") - // to unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "NormalizedNameData") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefPreprocessingNameSignals) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefPreprocessingNameSignals - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// RepositoryWebrefPreprocessingNameVariantData: Represents a single -// name with all its signal, like language, sources and confidences. -type RepositoryWebrefPreprocessingNameVariantData struct { - // VariantSignals: Sources providing this name variant and their - // metadata. NOTE: by convention we only allow one proto per source. - VariantSignals []*RepositoryWebrefPreprocessingNameVariantSignals `json:"variantSignals,omitempty"` - - // ForceSendFields is a list of field names (e.g. "VariantSignals") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "VariantSignals") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefPreprocessingNameVariantData) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefPreprocessingNameVariantData - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // RepositoryWebrefPreprocessingNameVariantSignals: Next available tag: // 33. type RepositoryWebrefPreprocessingNameVariantSignals struct { @@ -118031,18 +118117,11 @@ type RepositoryWebrefPreprocessingNameVariantSignals struct { // "KG_ALIAS" // "KG_ISBN13" // "KG_GTIN" - // "KG_PRONUNCIATION" // "KG_STOCK_TICKER" // "KG_AVIATION" - // "KG_CARS" - // "KG_AWARDS" - // "KG_WEBSITE_DERIVED_NAME" - // "KG_BRACKET_STRIPPED_DERIVED_NAME" - // "KG_LOCATION_DERIVED_NAME" - // "KG_TRUSTED_ALIAS" - KG aliases that were manually generated, such - // as car model years. + // "KG_TRUSTED_ALIAS" - KG aliases that were manually generated, e.g. + // SxEy names for TV episodes // "KG_CHEMICAL_SYMBOL" - // "KG_YEAR" // "KG_RADIO_STATION" // "KG_REVERSE_UNIQUE_PROPERTY" // "KG_TRANSIT_STATION_CODE" @@ -118057,10 +118136,7 @@ type RepositoryWebrefPreprocessingNameVariantSignals struct { // /namespace/webref/static-data/entity-name-translations/ // "MAPFACTS" // "MAPFACTS_PHONENUMBER" - // "MAPFACTS_PERSON_NAME_GENERATOR" - // "MAPFACTS_PERSON_FIRST_NAME_GENERATOR" // "MAPFACTS_STREET_NAME_GENERATOR" - // "MAPFACTS_SCORER" // "MAPFACTS_FUZZY_PHONENUMBER" // "MAPFACTS_NAME_GENERATOR" // "MAPFACTS_GEOCODES_ADDRESS_LINES" @@ -118071,100 +118147,46 @@ type RepositoryWebrefPreprocessingNameVariantSignals struct { // prefixed country code, e.g. I 39303, A 6604, CH 8005. // "MAPFACTS_TRANSIT_LINE_NAME_GENERATOR" // "MAPFACTS_HOUSE_ID" - // "COOC" // "CDOCS" // "CDOCS_ANCHOR" // "CDOCS_NAVBOOST" - // "CDOCS_WIKIPEDIA" // "CDOCS_REFERENCE_PAGE_URL" - // "CDOCS_SCORER" - // "CDOCS_REFERENCE_PAGE_URL_DERIVED" - Reference page urls stripped - // of web prefixes. // "WIKIJOINS" - // "WIKIJOINS_NICKNAME" // "WIKIDATA_AKA" // "WIKIDATA_LABEL" - // "WIKIJOIN_FRAGMENT_REDIRECT" - // "WIKIJOIN_ALIAS" - Aliases mined from Wikipedia pages, with sources - // such as infoboxes and bolded description text. // "PRODUCT" // "PRODUCT_TITLE" - // "PRODUCT_TITLE_VARIATION" - // "PRODUCT_QUERY" - // "PRODUCT_STRONG_IDENTIFIER" // "PRODUCT_MANUFACTURER_PART_NUMBER" // "PRODUCT_MODEL_VARIATION" - // "PRODUCT_UNTRUSTED" // "PRODUCT_COMPANY_OR_BRAND_STRIPPING" // "PRODUCT_AGGRESSIVE_STRIP" // "PRODUCT_AGGRESSIVE_BRAND_STRIP" - // "PER_ENTITY_SCORE_AGGREGATOR" - // "PER_ENTITY_SCORE_AGGREGATOR_ENTITY_KEYED" - // "PER_ENTITY_SCORE_AGGREGATOR_NAME_KEYED" - // "PER_ENTITY_SCORE_AGGREGATOR_FINAL" // "SCORER" - // "SCORER_BEST_NAME_PICKER" - // "SCORER_COMMON_NGRAM_CONCEPT_BOOST" - // "SCORER_LEGACY_COMMON_NGRAM_CONCEPT_BOOST" - // "SCORER_SYNTACTIC_NAME_PROMOTION" // "SCORER_CATEGORICAL_NAME_SUPPRESSOR" - // "SCORER_TYPE_BASED_MULTIPLIER" - // "SCORER_NAVINESS_GUARANTEE" - // "SCORER_SINGLE_LETTER_NAME_DEMOTION" - // "SCORER_TRUST_EXTRAPOLATION" - // "SCORER_TRUST_DERIVATION" - // "SCORER_AWARDS_VERTICAL" - For the awards vertical for award - // categories we only trust names that come from structured data. This - // way we achieve our precision targets. // "SCORER_BAD_SUBNAME_DEMOTION" // "SCORER_YEAR_NAME_DEMOTION" - Scorer that checks and kills // year-like names. - // "SCORER_ENTITY_NAME_RATIO" - // "SCORER_COLLECTION_PATTERN" // "SCORER_NAME_BLACKLIST" - // "SCORER_TOKEN_CLUSTERING" - // "SCORER_DEPRECATED_TOKEN_CLUSTERING" // "NAME_LEAKAGE_PREVENTION" - // "PER_ENTITY_NAME_LEAKAGE_PREVENTION" - // "PER_NAME_NAME_LEAKAGE_PREVENTION" - // "SPECIFICITY_COMPUTER" // "INCOMPATIBLE_NUMBER_DEMOTION" // "BAD_STRIPPED_NAME" // "BAD_FRINGE_NAME" // "BAD_PERSON_NAME" // "PERSON_NAME_GENERATOR" // "PERSON_NAME_GENERATOR_WITH_INITIALS" - // "HEBREW_LOCATION_NAME_INFLECTOR" // "INJECTED" - This source is used for names injected in the name // pipeline. This injection is a shortcut to get names in the model and // should only be used as a temporary solution waiting to either put the // names in KG or mine them directly in this pipeline. - // "INJECTED_SHOWTIMES_CHAIN" - // "INJECTED_OLYMPICS" - // "MINI_COOC" - Replaceability signals from mini cooc. - // "MORPHOLOGY" - // "LYRICS_TRUSTED_NAME" - Names considered trusted as they are found - // in lyrics. - // "NAME_ANNOTATION_PROCESSOR" - // "COMPANY_DERIVED_NAME" // "AFFIXED_NAME_GENERATOR" - // "AFFIXED_NAME_GENERATOR_TRUSTED" - // "BUSINESS_DERIVED_NAME" // "BUSINESS_SUFFIX_STRIPPED_NAME" // "CHAIN_NAME_GENERATOR" - // "DEPRECATED_LOCATION_STRIPPED_NAME" // "LOCATION_STRIPPED_NAME" - // "LOCATION_STRIPPED_NAVBOOST_NAME" - // "PARENT_NAME_GENERATOR" - // "PROPAGATE_NAMES" // "PUNCTUATION_STRIPPED_NAME" // "LEXICON_GENERATOR" - // "NAME_SYNONYMS" - // "CURATED_NAME" // "COMPOUND_NAME" // "INDIC_NORMALIZER" // "STRIP_FIRST_STOPWORD" - // "CONJUNCTION_NORMALIZE" // "MIX_CASE_NORMALIZE" // "MOVIE_YEAR" // "STRIP_IMPLICATION" @@ -118173,18 +118195,12 @@ type RepositoryWebrefPreprocessingNameVariantSignals struct { // "STRIP_WIKI" // "CIVICS_NAME_GENERATOR" // "STRIPPED_THEATER_NAME" - // "TRANSLITERATION" // "NUMBER_VARIANT_GENERATOR" // "PERSONAL_MEDIA_NAME_GENERATOR" - // "MRF_INDEXING_NAME" - Names used for entity retrieval by MRF. - // "MRF_INDEXING_NAME_TV_SHOWS" - // "MATCH" - Sources marking particular types of matches. + // "MRF_INDEXING_NAME_TV_SHOWS" - Names used for entity retrieval by + // MRF. // "MATCH_WITH_MIDDLE_INITIALS" - Name is matched on middle initials. - // "COMPOUND_RETRIEVAL_KEY" - A special key constructed as a - // combination of multiple items (mids, properties, etc.). Use cases - // include retrieval of compound entities based on components, - // potentially MDVC resolution in WebRef. - // "EVENT_RETRIEVAL_KEY" - A special key for event retrieval. + // "COMBINED" - Source indicating a composition of signal sources. Source string `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Scores") to @@ -118210,38 +118226,6 @@ func (s *RepositoryWebrefPreprocessingNameVariantSignals) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RepositoryWebrefPreprocessingNormalizedNameData: Aggregation of all -// names of an entity that normalize to the same string. -type RepositoryWebrefPreprocessingNormalizedNameData struct { - // NameVariantData: Name variants and their signals by source. All these - // name variants normalize to @normalized_name given their locales. - // NOTE: This includes metadata aggregated for the normalized name. - NameVariantData []*RepositoryWebrefPreprocessingNameVariantData `json:"nameVariantData,omitempty"` - - // ForceSendFields is a list of field names (e.g. "NameVariantData") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "NameVariantData") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefPreprocessingNormalizedNameData) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefPreprocessingNormalizedNameData - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - type RepositoryWebrefPreprocessingOriginalNames struct { // Count: The total number of original names that a normalized name has // (all versions from all different sources). @@ -119775,168 +119759,6 @@ func (s *RepositoryWebrefTaskDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RepositoryWebrefToprefListMembership: Entity-level classification. -// Template: experimental/topref/eval_entities/template.jhtml -type RepositoryWebrefToprefListMembership struct { - Member []*RepositoryWebrefToprefListMembershipListMember `json:"member,omitempty"` - - TaskData *RepositoryWebrefTaskData `json:"taskData,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Member") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Member") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefToprefListMembership) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefToprefListMembership - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -type RepositoryWebrefToprefListMembershipListMember struct { - Id *RepositoryWebrefWebrefEntityId `json:"id,omitempty"` - - // Possible values: - // "YES_NO_UNSURE_NONE" - // "YES" - // "NO" - // "UNSURE" - IsMember string `json:"isMember,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Id") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Id") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefToprefListMembershipListMember) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefToprefListMembershipListMember - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// RepositoryWebrefToprefPageClassification: Top-level page -// classification. Template: -// experimental/topref/eval_main/template.jhtml -type RepositoryWebrefToprefPageClassification struct { - // Possible values: - // "YES_NO_UNSURE_NONE" - // "YES" - // "NO" - // "UNSURE" - IsList string `json:"isList,omitempty"` - - // Possible values: - // "YES_NO_UNSURE_NONE" - // "YES" - // "NO" - // "UNSURE" - IsListTypeCorrect string `json:"isListTypeCorrect,omitempty"` - - // Possible values: - // "YES_NO_UNSURE_NONE" - // "YES" - // "NO" - // "UNSURE" - IsRanking string `json:"isRanking,omitempty"` - - // Possible values: - // "YES_NO_UNSURE_NONE" - // "YES" - // "NO" - // "UNSURE" - IsToplist string `json:"isToplist,omitempty"` - - // ListType: A string generated based on the main collection of the - // list. E.g., /collection/geo/restaurant => "Restaurants" retrieved by - // following the /base/schemastaging/context_name/plural in KG. - ListType string `json:"listType,omitempty"` - - // RatedTitle: "repeated" because we potentially evaluate several (up to - // 5) title candidates for the page. - RatedTitle []*RepositoryWebrefToprefPageClassificationRatedTitle `json:"ratedTitle,omitempty"` - - TaskData *RepositoryWebrefTaskData `json:"taskData,omitempty"` - - // ForceSendFields is a list of field names (e.g. "IsList") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "IsList") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefToprefPageClassification) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefToprefPageClassification - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -type RepositoryWebrefToprefPageClassificationRatedTitle struct { - // Possible values: - // "YES_NO_UNSURE_NONE" - // "YES" - // "NO" - // "UNSURE" - IsGood string `json:"isGood,omitempty"` - - Title string `json:"title,omitempty"` - - // ForceSendFields is a list of field names (e.g. "IsGood") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "IsGood") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefToprefPageClassificationRatedTitle) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefToprefPageClassificationRatedTitle - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - type RepositoryWebrefTripleAnnotation struct { // ConfidenceScore: Triple annotation confidence_score (value between 0 // and 1). Higher values correspond to higher confidence. @@ -120814,8 +120636,10 @@ type RepositoryWebrefWebrefAttachmentMetadata struct { // for a user to meet a taxi, ridesharing vehicle, or general driver. // "TYPE_REGULATED_AREA" - An area controlled in some way by an // authoritative source, such as a government-designated COVID - // containment zone. Features of this type should have one or more gcids - // corresponding to their specific regulation. + // containment zone or an area under government sanctions. Features of + // this type should have one or more gcids corresponding to their + // specific regulation, and client handling of these features may vary + // based on the type of regulation. // "TYPE_LOGICAL_BORDER" - A grouping of TYPE_BORDER features ("border // segments"), which together represent a border between two features of // the same type. @@ -123660,6 +123484,7 @@ type ResearchScienceSearchSourceUrlDocjoinInfo struct { // "SPORE_DUMP" - Fetched through the data dump by Spore team, aka // '/namespace/custom_corpus/prod/clients/tpkit/science_search/export-spo // re/ttl=3d/...' + // "INFERRED" - Inferred using ML DataSource string `json:"dataSource,omitempty"` // DisplayUrl: The url used to display in the google search results. @@ -123761,6 +123586,7 @@ type ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo struct { // "UNKNOWN" // "FIELD_OF_STUDY" - /collection/field_of_studies in KG. // "GEO" - /collection/geo/* in KG. + // "ORGANIZATION" - /collection/organization/* in KG EntityType string `json:"entityType,omitempty"` // Mid: The KG identifier of the WebrefEntity. @@ -124098,77 +123924,6 @@ func (s *SafesearchVideoContentSignals) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ScholarCitationPredictionSignal: An input into the citation -// prediction model. -type ScholarCitationPredictionSignal struct { - // Possible values: - // "METRIC_TYPE_NONE" - // "METRIC_TYPE_MEAN" - // "METRIC_TYPE_MEDIAN" - // "METRIC_TYPE_20_80" - Average of 20th and 80th percentiles. - MetricType string `json:"metricType,omitempty"` - - // Possible values: - // "SIGNAL_UNKNOWN" - // "SIGNAL_NUM_FORWARD_LINKS" - Single fields. - // "SIGNAL_ANY_PUBLICATION" - // "SIGNAL_PUBORG" - // "SIGNAL_AUTHOR_EMAIL_DOMAIN" - // "SIGNAL_AUTHOR_DOC_LENGTH" - Pairs. - // "SIGNAL_AUTHOR_TITLE_NGRAM" - // "SIGNAL_VENUE_DOC_LENGTH" - // "SIGNAL_VENUE_TITLE_NGRAM" - // "SIGNAL_ANY_PUBLICATION_AUTHOR" - // "SIGNAL_ANY_PUBLICATION_DOC_LENGTH" - // "SIGNAL_ANY_PUBLICATION_TITLE_NGRAM" - // "SIGNAL_PUBORG_DOC_LENGTH" - // "SIGNAL_HOST_NAME_TITLE_NGRAM" - // "SIGNAL_TOTAL_CITATIONS" - // "SIGNAL_LAST_YEAR_CITATIONS" - // "SIGNAL_2_YEARS_AGO_CITATIONS" - // "SIGNAL_CITATIONS_PER_YEAR" - // "SIGNAL_YEARS_WITH_NO_CITATION" - SignalType string `json:"signalType,omitempty"` - - Value float64 `json:"value,omitempty"` - - // ForceSendFields is a list of field names (e.g. "MetricType") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "MetricType") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *ScholarCitationPredictionSignal) MarshalJSON() ([]byte, error) { - type NoMethod ScholarCitationPredictionSignal - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -func (s *ScholarCitationPredictionSignal) UnmarshalJSON(data []byte) error { - type NoMethod ScholarCitationPredictionSignal - var s1 struct { - Value gensupport.JSONFloat64 `json:"value"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.Value = float64(s1.Value) - return nil -} - type ScienceCitation struct { // Possible values: // "UNKNOWN_ABSTRACT_DISPLAY" @@ -124248,6 +124003,11 @@ type ScienceCitation struct { // CitationSrc: DEPRECATED: use CitationSource CitationSrc string `json:"CitationSrc,omitempty"` + // Possible values: + // "CLEARED_REASON_NONE" + // "CLEARED_REASON_TOC" + ClearedReason string `json:"ClearedReason,omitempty"` + // ClusterDiscoveryDate: Used for logging, recommendations, and // sort-by-date. Contains the earliest discovery date of the cluster, // adjusted for earlier publication dates. Stored in Universal time @@ -125406,194 +125166,111 @@ func (s *ScienceOceanViewCountryView) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// SciencePerDocData: Next tag: 43 -type SciencePerDocData struct { - // AbstractEndPosition: The first hit position after the end of the - // abstract. We index the abstract immediately after the body, so all - // hits between BodyEndPosition and AbstractEndPosition are from the - // abstract. - AbstractEndPosition int64 `json:"AbstractEndPosition,omitempty"` - - // BodyEndPosition: The first hit position past the last body hit. - BodyEndPosition int64 `json:"BodyEndPosition,omitempty"` - - // CitationPredictionSignal: Input features used to compute - // PredictedCitations. - CitationPredictionSignal []*ScholarCitationPredictionSignal `json:"CitationPredictionSignal,omitempty"` - - // CourtLevel: Used for sorting legal documents by court; e.g. Supreme - // Court > Appeals Court > Trial Court - CourtLevel int64 `json:"CourtLevel,omitempty"` - - DEPRECATEDCrawlTime int64 `json:"DEPRECATEDCrawlTime,omitempty,string"` - - // DiscoveryAgeInDays: The age in days since discovery date at the time - // of indexing. Used to compute PredictedCitations. - DiscoveryAgeInDays int64 `json:"DiscoveryAgeInDays,omitempty"` - - // DiscoveryTimestamp: Used for sorting articles by date, and as an - // input for recent-query ranking. Stored in Universal time scale (100 - // ns ticks since 0001 AD). - DiscoveryTimestamp int64 `json:"DiscoveryTimestamp,omitempty,string"` - - // IsCitationOnly: citation-only marker - for use in scorer - IsCitationOnly bool `json:"IsCitationOnly,omitempty"` - - // NonScholarlinessPenalty: Scoring penalty for non-scholarly articles. - // In the range [0, 1], with 0 being no penalty and 1 being the full - // penalty. - NonScholarlinessPenalty float64 `json:"NonScholarlinessPenalty,omitempty"` - - // NumBackwardLinks: Summary statistics, for display in the FE. - NumBackwardLinks int64 `json:"NumBackwardLinks,omitempty"` - - NumRelated int64 `json:"NumRelated,omitempty"` - - // NumTitleWords: Used for exact title boost in Scholar, as of 1/7/2008. - NumTitleWords int64 `json:"NumTitleWords,omitempty"` - - NumVersions int64 `json:"NumVersions,omitempty"` - - OffDomAnchors int64 `json:"OffDomAnchors,omitempty"` - - OnSiteAnchors int64 `json:"OnSiteAnchors,omitempty"` - - // PredictedCitations: The predicted new citations for this document - // once it reaches 5 years after its discovery date. Not set for: - - // Documents 5 years or older - Citation only documents - Patents and - // legal documents - PredictedCitations float64 `json:"PredictedCitations,omitempty"` - - // PredictedCitationsNext5Years: The predicted new citations for this - // document over the next 5 years. This differs from the - // PredictedCitations field in that this is set for documents of all - // ages, whereas PredictedCitations is only set for new documents. This - // is also a prediction over a fixed time interval, whereas the time - // interval for PredictedCitations depends on the document's age. - PredictedCitationsNext5Years float64 `json:"PredictedCitationsNext5Years,omitempty"` - - PublicationDay int64 `json:"PublicationDay,omitempty"` - - PublicationMonth int64 `json:"PublicationMonth,omitempty"` - - // PublicationYear: Publication date. Used both for ranking of recent - // articles and for display in the FE. - PublicationYear int64 `json:"PublicationYear,omitempty"` +type SdrEmbedding struct { + Values []float64 `json:"values,omitempty"` - // ScholarId: For links from websearch to scholar. - ScholarId uint64 `json:"ScholarId,omitempty,string"` + Version int64 `json:"version,omitempty"` - // Subject: DEPRECATED e.g., fp("med") - Subject int64 `json:"Subject,omitempty"` + // ForceSendFields is a list of field names (e.g. "Values") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` - // TitleNgrams: A string encoding the uni-, bi-, and trigram weights in - // the title. This is encoded and decoded by - // science_search/util/title_ngrams.h. - TitleNgrams string `json:"TitleNgrams,omitempty"` + // NullFields is a list of field names (e.g. "Values") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} - // TotalAnchors: Anchor count info for scorer - TotalAnchors int64 `json:"TotalAnchors,omitempty"` +func (s *SdrEmbedding) MarshalJSON() ([]byte, error) { + type NoMethod SdrEmbedding + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} - // Type: The type of the article - paper, review, patent, etc. - // - // Possible values: - // "FIRST_ARTICLE_TYPE" - // "PAPER" - // "BOOK" - // "BOOKLET" - unused; - // "CONFERENCE" - synonym for PAPER; - // "INBOOK" - // "INCOLLECTION" - // "MANUAL" - // "MS_THESIS" - // "MISC" - // "PHD_THESIS" - // "TECHREPORT" - // "UNPUBLISHED" - // "PATENT" - // "WEB_SITE" - // "BS_THESIS" - // "REVIEW_ARTICLE" - // "JOURNAL" - entire journal, not an article - // "LEGAL_DOC" - // "BIBLIOGRAPHY" - // "BOOK_REVIEW" - // "RETRACTION" - For tracking - // "EDITORIAL" - // "ART_PERF_REVIEW" - // "POETRY" - // "FICTION" - // "NEWS" - // "BIOGRAPHICAL" - // "LEGISLATION" - // "REFERENCE_MATERIAL" - // "STANDARD" - // "META_ANALYSIS" - // "RANDOMIZED_TRIAL" - // "NUM_ARTICLE_TYPES" - Type string `json:"Type,omitempty"` +type SdrPageAnchorsDocInfo struct { + Articleness float64 `json:"articleness,omitempty"` - Author []*SciencePerDocDataAuthor `json:"author,omitempty"` + PageAnchors []*SdrPageAnchorsSitelink `json:"pageAnchors,omitempty"` - Referencediscussion []*SciencePerDocDataReferenceDiscussion `json:"referencediscussion,omitempty"` + Qscore float64 `json:"qscore,omitempty"` - // Section: Section markers, sorted by begin_position, no overlapping. - Section []*SciencePerDocDataSection `json:"section,omitempty"` + SitelinkWrapper []*SdrPageAnchorsSitelinkWrapper `json:"sitelinkWrapper,omitempty"` - Signal []*SciencePerDocDataSignal `json:"signal,omitempty"` + TextRichness float64 `json:"textRichness,omitempty"` - // ForceSendFields is a list of field names (e.g. "AbstractEndPosition") - // to unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "Articleness") to + // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AbstractEndPosition") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "Articleness") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } -func (s *SciencePerDocData) MarshalJSON() ([]byte, error) { - type NoMethod SciencePerDocData +func (s *SdrPageAnchorsDocInfo) MarshalJSON() ([]byte, error) { + type NoMethod SdrPageAnchorsDocInfo raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -func (s *SciencePerDocData) UnmarshalJSON(data []byte) error { - type NoMethod SciencePerDocData +func (s *SdrPageAnchorsDocInfo) UnmarshalJSON(data []byte) error { + type NoMethod SdrPageAnchorsDocInfo var s1 struct { - NonScholarlinessPenalty gensupport.JSONFloat64 `json:"NonScholarlinessPenalty"` - PredictedCitations gensupport.JSONFloat64 `json:"PredictedCitations"` - PredictedCitationsNext5Years gensupport.JSONFloat64 `json:"PredictedCitationsNext5Years"` + Articleness gensupport.JSONFloat64 `json:"articleness"` + Qscore gensupport.JSONFloat64 `json:"qscore"` + TextRichness gensupport.JSONFloat64 `json:"textRichness"` *NoMethod } s1.NoMethod = (*NoMethod)(s) if err := json.Unmarshal(data, &s1); err != nil { return err } - s.NonScholarlinessPenalty = float64(s1.NonScholarlinessPenalty) - s.PredictedCitations = float64(s1.PredictedCitations) - s.PredictedCitationsNext5Years = float64(s1.PredictedCitationsNext5Years) + s.Articleness = float64(s1.Articleness) + s.Qscore = float64(s1.Qscore) + s.TextRichness = float64(s1.TextRichness) return nil } -// SciencePerDocDataAuthor: Used for exact author boost and for display -// in the FE. -type SciencePerDocDataAuthor struct { - IsCJK bool `json:"IsCJK,omitempty"` +type SdrPageAnchorsSitelink struct { + // Embedding: Needed for relevance scoring. + Embedding *SdrEmbedding `json:"embedding,omitempty"` - LastName string `json:"LastName,omitempty"` + // GeometryScore: aggregate score from Section Geometry. + GeometryScore float64 `json:"geometryScore,omitempty"` - OtherNames string `json:"OtherNames,omitempty"` + // HeadingAbbrvScore: Heading Abbreviation score. + HeadingAbbrvScore float64 `json:"headingAbbrvScore,omitempty"` + + // HpScore: Needed for heading/passage filtering. + HpScore float64 `json:"hpScore,omitempty"` + + Level int64 `json:"level,omitempty"` + + ScrollTo *SdrScrollTo `json:"scrollTo,omitempty"` - // ForceSendFields is a list of field names (e.g. "IsCJK") to + // SectionHeight: Needed for Geometry Scoring and backoffs. from Section + // Geometry. + SectionHeight int64 `json:"sectionHeight,omitempty"` + + // Text: Heading/Reformulated text is needed to display. + Text string `json:"text,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Embedding") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -125601,8 +125278,8 @@ type SciencePerDocDataAuthor struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "IsCJK") to include in API - // requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "Embedding") to include in + // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. @@ -125610,54 +125287,90 @@ type SciencePerDocDataAuthor struct { NullFields []string `json:"-"` } -func (s *SciencePerDocDataAuthor) MarshalJSON() ([]byte, error) { - type NoMethod SciencePerDocDataAuthor +func (s *SdrPageAnchorsSitelink) MarshalJSON() ([]byte, error) { + type NoMethod SdrPageAnchorsSitelink raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -type SciencePerDocDataReferenceDiscussion struct { - Level int64 `json:"Level,omitempty"` +func (s *SdrPageAnchorsSitelink) UnmarshalJSON(data []byte) error { + type NoMethod SdrPageAnchorsSitelink + var s1 struct { + GeometryScore gensupport.JSONFloat64 `json:"geometryScore"` + HeadingAbbrvScore gensupport.JSONFloat64 `json:"headingAbbrvScore"` + HpScore gensupport.JSONFloat64 `json:"hpScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.GeometryScore = float64(s1.GeometryScore) + s.HeadingAbbrvScore = float64(s1.HeadingAbbrvScore) + s.HpScore = float64(s1.HpScore) + return nil +} - TargetID uint64 `json:"TargetID,omitempty,string"` +// SdrPageAnchorsSitelinkWrapper: This wrapper is used for passing in +// additional information to generate embeddings in Goldmine. +type SdrPageAnchorsSitelinkWrapper struct { + AbbreviatedHeadingText string `json:"abbreviatedHeadingText,omitempty"` - // ForceSendFields is a list of field names (e.g. "Level") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. + AbbrvEmbedding *SdrEmbedding `json:"abbrvEmbedding,omitempty"` + + HeadingEmbedding *SdrEmbedding `json:"headingEmbedding,omitempty"` + + NormalizedHeadingText string `json:"normalizedHeadingText,omitempty"` + + PassageEmbedding *SdrEmbedding `json:"passageEmbedding,omitempty"` + + PassageText string `json:"passageText,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AbbreviatedHeadingText") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Level") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "AbbreviatedHeadingText") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } -func (s *SciencePerDocDataReferenceDiscussion) MarshalJSON() ([]byte, error) { - type NoMethod SciencePerDocDataReferenceDiscussion +func (s *SdrPageAnchorsSitelinkWrapper) MarshalJSON() ([]byte, error) { + type NoMethod SdrPageAnchorsSitelinkWrapper raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -type SciencePerDocDataSection struct { - // BeginPosition: The first hit position at the start of the section. - BeginPosition int64 `json:"beginPosition,omitempty"` +// SdrScrollTo: Data needed to construct a go/scroll-to text fragment. +// The url fragment is: #:~:text=[prefix-,]text_start,text_end +type SdrScrollTo struct { + OnpageMatches *SdrScrollToOnPageMatches `json:"onpageMatches,omitempty"` - // NumPositions: Delta in hit position from the start of the section to - // the end. - NumPositions int64 `json:"numPositions,omitempty"` + // Prefix: Prefix to help with disambiguating between multiple text + // matches on page. Optional. + Prefix string `json:"prefix,omitempty"` - // Possible values: - // "UNKNOWN" - // "REFERENCE" - Type string `json:"type,omitempty"` + // Suffix: Suffix to help with disambiguating between multiple text + // matches on page. Optional. + Suffix string `json:"suffix,omitempty"` + + // TextEnd: End of the text span to be highlighted. Optional. + TextEnd string `json:"textEnd,omitempty"` - // ForceSendFields is a list of field names (e.g. "BeginPosition") to + // TextStart: Start of the text span to be highlighted. + TextStart string `json:"textStart,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OnpageMatches") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -125665,7 +125378,7 @@ type SciencePerDocDataSection struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BeginPosition") to include + // NullFields is a list of field names (e.g. "OnpageMatches") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as @@ -125674,42 +125387,25 @@ type SciencePerDocDataSection struct { NullFields []string `json:"-"` } -func (s *SciencePerDocDataSection) MarshalJSON() ([]byte, error) { - type NoMethod SciencePerDocDataSection +func (s *SdrScrollTo) MarshalJSON() ([]byte, error) { + type NoMethod SdrScrollTo raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -type SciencePerDocDataSignal struct { - // AvgCitations: Values for different metrics - AvgCitations float64 `json:"avgCitations,omitempty"` - - // Count: Number of papers in the bucket for this paper/signal - // combination 16-bit value - Count int64 `json:"count,omitempty"` - - // GeThres1Count: Count of papers with 10 or more citations (ge is >=) - // 16-bit value - GeThres1Count int64 `json:"geThres1Count,omitempty"` - - // GeThres2Count: Count of papers with 50 or more citations 16-bit value - GeThres2Count int64 `json:"geThres2Count,omitempty"` - - // Index: Signal type dependent (for Journals refers to the year) index - // must refers to years ago not absolute year. 8-bit value - Index int64 `json:"index,omitempty"` +// SdrScrollToOnPageMatches: Number of matches in the page when using +// text alone, prefix + text, text + suffix, and prefix + text + suffix. +// The match is case-insensitive to align with go/scroll-to behavior. +type SdrScrollToOnPageMatches struct { + Text int64 `json:"text,omitempty"` - MedianCitations float64 `json:"medianCitations,omitempty"` + TextWithPrefix int64 `json:"textWithPrefix,omitempty"` - Type int64 `json:"type,omitempty"` + TextWithPrefixSuffix int64 `json:"textWithPrefixSuffix,omitempty"` - // Weight: Authors own a part of a paper value. This is the cumulative - // weight. If all papers falling into this bucket are single author - // papers, then weight will be equal to 1.0. Otherwise it will be - // smaller. - Weight float64 `json:"weight,omitempty"` + TextWithSuffix int64 `json:"textWithSuffix,omitempty"` - // ForceSendFields is a list of field names (e.g. "AvgCitations") to + // ForceSendFields is a list of field names (e.g. "Text") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -125717,39 +125413,21 @@ type SciencePerDocDataSignal struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AvgCitations") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as + // NullFields is a list of field names (e.g. "Text") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } -func (s *SciencePerDocDataSignal) MarshalJSON() ([]byte, error) { - type NoMethod SciencePerDocDataSignal +func (s *SdrScrollToOnPageMatches) MarshalJSON() ([]byte, error) { + type NoMethod SdrScrollToOnPageMatches raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -func (s *SciencePerDocDataSignal) UnmarshalJSON(data []byte) error { - type NoMethod SciencePerDocDataSignal - var s1 struct { - AvgCitations gensupport.JSONFloat64 `json:"avgCitations"` - MedianCitations gensupport.JSONFloat64 `json:"medianCitations"` - Weight gensupport.JSONFloat64 `json:"weight"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.AvgCitations = float64(s1.AvgCitations) - s.MedianCitations = float64(s1.MedianCitations) - s.Weight = float64(s1.Weight) - return nil -} - // SearchPolicyRankableSensitivity: Encapsulates sensitivity mode, // source, and other metadata, used for ranking when there are multiple // sensitivies set by default sources (eg, followon, query @@ -127564,6 +127242,11 @@ type Sitemap struct { DeprecatedTarget []*SitemapDEPRECATEDTarget `json:"deprecatedTarget,omitempty"` + // PageAnchorsDocInfo: This field is populated in the Sitemap MDU + // subpopulator from cdoc data. This is used to store page anchors + // information for TopicTagsScrolltoFlow. + PageAnchorsDocInfo *SdrPageAnchorsDocInfo `json:"pageAnchorsDocInfo,omitempty"` + // SearchInSite: Enable site search. SearchInSite bool `json:"searchInSite,omitempty"` @@ -128203,6 +127886,8 @@ func (s *SnippetExtraInfoSnippetScoringInfo) UnmarshalJSON(data []byte) error { // input processor used to generate SnippetsBrain scores, if // SnippetsBrain debugging is enabled. type SnippetExtraInfoSnippetsBrainModelInfo struct { + Ng3ModelName string `json:"ng3ModelName,omitempty"` + // SnippetsbrainModelName: The below fields are populated by SnippetFlow // in superroot. SnippetsbrainModelName string `json:"snippetsbrainModelName,omitempty"` @@ -128211,22 +127896,20 @@ type SnippetExtraInfoSnippetsBrainModelInfo struct { SnippetsbrainTokenizerType string `json:"snippetsbrainTokenizerType,omitempty"` - // ForceSendFields is a list of field names (e.g. - // "SnippetsbrainModelName") to unconditionally include in API requests. - // By default, fields with empty or default values are omitted from API - // requests. However, any non-pointer, non-interface field appearing in - // ForceSendFields will be sent to the server regardless of whether the - // field is empty or not. This may be used to include empty fields in - // Patch requests. + // ForceSendFields is a list of field names (e.g. "Ng3ModelName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SnippetsbrainModelName") - // to include in API requests with the JSON null value. By default, - // fields with empty values are omitted from API requests. However, any - // field with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "Ng3ModelName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } @@ -129288,7 +128971,12 @@ func (s *SocialGraphApiProtoDelegatedGroupId) MarshalJSON() ([]byte, error) { type SocialGraphApiProtoDisplayNameSource struct { // Possible values: // "DISPLAY_NAME_SOURCE_UNSPECIFIED" - // "LIMITED_PROFILE" + // "LIMITED_PROFILE" - DEPRECATED(b/248135053): in favor of + // `LIMITED_PROFILE_FULL_NAME`, and `LIMITED_PROFILE_SHORTENED_NAME` + // "LIMITED_PROFILE_FULL_NAME" - The source is the limited profile, + // and the full name is visible. + // "LIMITED_PROFILE_SHORTENED_NAME" - The source is the limited + // profile, and it's a shortened name. Source string `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Source") to @@ -129599,8 +129287,7 @@ func (s *SocialGraphApiProtoMonthlyRecurrence) MarshalJSON() ([]byte, error) { type SocialGraphApiProtoMonthlyWeekdayRecurrence struct { // WeekDay: The nth occurrence of week_day to match. I.e. For 3rd // Wednesday of the month, week_day = WEDNESDAY and week_day_number = 3. - // Values beyond the end of the month are skipped. Negative values are - // relative from end of month (e.g. Last Friday of every month). + // Values beyond the end of the month are skipped. // // Possible values: // "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified. @@ -130157,16 +129844,18 @@ func (s *SocialGraphApiProtoPronunciations) MarshalJSON() ([]byte, error) { // Monthly recurrence such as: third Thursday of every month: // monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY // week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService -// (not in ProfileService) TODO(b/240850530) add link to validators when -// created. +// (not in ProfileService) The canonical recurrence validation function +// is located here: +// http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb type SocialGraphApiProtoRecurrence struct { DailyRecurrence *SocialGraphApiProtoDailyRecurrence `json:"dailyRecurrence,omitempty"` // Every: Multiplier on the frequency of the recurrence. Use this to - // specify patterns that recur every X days, months, years, etc. - // Example: [remind me to call mom every 2nd week]. Default value will - // be considered 1 (every day,every week,...) and not 0. This is ignored - // for a SingleRecurrence. Optional. + // specify patterns that recur every X days, months, years, etc. Must be + // a positive int. Example: [remind me to call mom every 2nd week]. If + // this field isn't set, it will default to 1 (every day,every week, + // etc). This field is ignored when recurrence_data is a + // SingleRecurrence. Optional. Every int64 `json:"every,omitempty"` MonthlyRecurrence *SocialGraphApiProtoMonthlyRecurrence `json:"monthlyRecurrence,omitempty"` @@ -130175,12 +129864,14 @@ type SocialGraphApiProtoRecurrence struct { RecurrenceEndDate *GoogleTypeDateTime `json:"recurrenceEndDate,omitempty"` // RecurrenceStart: The start of the recurrence can be represented as a - // DateTime. This is ignored for a SingleRecurrence. + // DateTime. This field is ignored when recurrence_data is a + // SingleRecurrence. RecurrenceStart *GoogleTypeDateTime `json:"recurrenceStart,omitempty"` // RepeatCount: Will repeat only a finite number of times. This is the // original number of times the recurrence will repeat and not how many - // times are left for it to repeat. + // times are left for it to repeat. This end type is not currently + // supported. RepeatCount int64 `json:"repeatCount,omitempty"` // RepeatForever: Will continue to repeat until prompt is deleted. @@ -130798,10 +130489,11 @@ func (s *SocialGraphApiProtoWeeklyRecurrence) MarshalJSON() ([]byte, error) { // SocialGraphApiProtoYearlyRecurrence: Pattern for a YEARLY recurrence. // A YEARLY recurrence is specified using a monthly pattern and a set of // months the pattern applies to. Some examples: "Every January 16" : -// monthly_pattern { month_day: 16 } months: JANUARY "Last day of every -// April and August" : monthly_pattern { month_day: -1 } months: APRIL -// months: AUGUST Used in PeopleAPI layers + FBS/ContactsService (not in -// ProfileService) +// monthly_pattern { monthly_day_recurrence { month_day: 16 } } months: +// JANUARY "Fourth Thursday of November and December" : monthly_pattern +// { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 4 +// } } months: NOVEMBER months: DECEMBER Used in PeopleAPI layers + +// FBS/ContactsService (not in ProfileService) type SocialGraphApiProtoYearlyRecurrence struct { // MonthlyPattern: The monthly pattern to recur. MonthlyPattern *SocialGraphApiProtoMonthlyRecurrence `json:"monthlyPattern,omitempty"` @@ -131635,6 +131327,85 @@ func (s *SocialStanzaStanzaRestriction) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SpamBrainData: This holds SpamBrain values which will be populated to +// docjoins & muppet. Proto is copied from spam_brain::SpamBrainData and +// populated at sitechunked site level (as opposed to the spambrain page +// classifier score). +type SpamBrainData struct { + // Site: Sitechunker site granularity for this result + Site string `json:"site,omitempty"` + + // VersionedData: Versioned scores of SB classifiers + VersionedData []*SpamBrainScore `json:"versionedData,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Site") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Site") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *SpamBrainData) MarshalJSON() ([]byte, error) { + type NoMethod SpamBrainData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// SpamBrainScore: Message representing versioned scores +type SpamBrainScore struct { + // SbScore: The value corresponding to this version. + SbScore float64 `json:"sbScore,omitempty"` + + // VersionId: The version id. + VersionId int64 `json:"versionId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "SbScore") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SbScore") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *SpamBrainScore) MarshalJSON() ([]byte, error) { + type NoMethod SpamBrainScore + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *SpamBrainScore) UnmarshalJSON(data []byte) error { + type NoMethod SpamBrainScore + var s1 struct { + SbScore gensupport.JSONFloat64 `json:"sbScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SbScore = float64(s1.SbScore) + return nil +} + // SpamCookbookAction: This protocol buffer indicates actions that we // take based on Cookbook recipes (see http://cookbook/) matching a // particular document. @@ -131909,6 +131680,53 @@ func (s *StorageGraphBfgLivegraphProvenanceMetadata) MarshalJSON() ([]byte, erro return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// StorageGraphBfgLmsPolicyMetadata: Metadata fields for LMS. See +// go/lms-online-restrictions for details. +type StorageGraphBfgLmsPolicyMetadata struct { + ClientIdsAllowed []string `json:"clientIdsAllowed,omitempty"` + + IsEditorial bool `json:"isEditorial,omitempty"` + + // ModificationsAllowed: Int values corresponds to the values of + // image_repository.licensed.api.restrictions.Modification enum. + ModificationsAllowed googleapi.Int64s `json:"modificationsAllowed,omitempty"` + + RegionsAllowed *KeGovernanceTypedRegions `json:"regionsAllowed,omitempty"` + + RegionsDisallowed *KeGovernanceTypedRegions `json:"regionsDisallowed,omitempty"` + + RequiresAttribution bool `json:"requiresAttribution,omitempty"` + + RequiresFirstPartyOnly bool `json:"requiresFirstPartyOnly,omitempty"` + + RequiresLinkback bool `json:"requiresLinkback,omitempty"` + + RequiresShareAlike bool `json:"requiresShareAlike,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ClientIdsAllowed") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ClientIdsAllowed") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *StorageGraphBfgLmsPolicyMetadata) MarshalJSON() ([]byte, error) { + type NoMethod StorageGraphBfgLmsPolicyMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // StorageGraphBfgPolicyMetadata: Metadata about data governance // policies. For more context, see go/ke-triple-dg-policy-and-metadata. // If any attribute is not set, then there's no specific restrictions @@ -131951,28 +131769,10 @@ type StorageGraphBfgPolicyMetadata struct { // consulting ke-data-governance@. LegalRemovalRegions []*KeGovernanceTypedRegions `json:"legalRemovalRegions,omitempty"` - LmsClientIdsAllowed []string `json:"lmsClientIdsAllowed,omitempty"` - - // LmsIsEditorial: The following attributes with `lms_` prefix are for - // supporting LMS restrictions. See go/lms-online-restrictions for - // details. - LmsIsEditorial bool `json:"lmsIsEditorial,omitempty"` - - // LmsModificationsAllowed: Int values corresponds to the values of - // image_repository.licensed.api.restrictions.Modification enum. - LmsModificationsAllowed googleapi.Int64s `json:"lmsModificationsAllowed,omitempty"` - - LmsRegionsAllowed *KeGovernanceTypedRegions `json:"lmsRegionsAllowed,omitempty"` - - LmsRegionsDisallowed *KeGovernanceTypedRegions `json:"lmsRegionsDisallowed,omitempty"` - - LmsRequiresAttribution bool `json:"lmsRequiresAttribution,omitempty"` - - LmsRequiresFirstPartyOnly bool `json:"lmsRequiresFirstPartyOnly,omitempty"` - - LmsRequiresLink bool `json:"lmsRequiresLink,omitempty"` - - LmsRequiresShareAlike bool `json:"lmsRequiresShareAlike,omitempty"` + // LmsPolicyMetadata: Policy metadata fields for LMS data. Only expected + // to be used by LMS providers -- please consult ke-data-governance@ + // before populating this field. + LmsPolicyMetadata *StorageGraphBfgLmsPolicyMetadata `json:"lmsPolicyMetadata,omitempty"` // PolicySourceType: Policy metadata are VERTICAL by default. Vertical // policy makers / providers does not need to set this field explicitly. @@ -136785,6 +136585,15 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // containing result of aQuality lookup during market details url // matching. A failed aQuality result suppresses inline details. // "INLINE_DETAILS_AQUALITY_CHECK_FAIL" + // "INLINE_DETAILS_IS_INLINE_URL_FRONTEND" - Event level test code for + // Aquality/Tquality filtering in LMD project. This is a duplicated + // testcode created for logging in frontend. + // "INLINE_DETAILS_TQUALITY_CHECK_PASS_FRONTEND" + // "INLINE_DETAILS_TQUALITY_CHECK_FAIL_FRONTEND" + // "INLINE_DETAILS_AQUALITY_CHECK_PASS_FRONTEND" + // "INLINE_DETAILS_AQUALITY_CHECK_FAIL_FRONTEND" + // "INLINE_DETAILS_CALLER_AQUALITY_CHECK_PASS_FRONTEND" + // "INLINE_DETAILS_CALLER_AQUALITY_CHECK_FAIL_FRONTEND" // "FRESH_RESULTS_SEEKING_CURRENT_YEAR_EVENT_LEVEL" - Event level test // code for tracking fresh results seeking within the current year // search queries. @@ -136823,6 +136632,16 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // Play Store IAP sales project at event-level. // go/play-store-iap-sales-dd // "GEARHEAD_ATTEMPT_USB_RECOVERY" - USB connection recovery. + // "MDP_P13N_ALL_EVENT_LEVEL" - MDP P13N + // "MDP_P13N_GAME_QUERY_L5_EVENT_LEVEL" + // "MDP_P13N_GAME_QUERY_L6_EVENT_LEVEL" + // "MDP_P13N_GAME_QUERY_L7_EVENT_LEVEL" + // "MDP_P13N_GAME_QUERY_L8_EVENT_LEVEL" + // "MDP_P13N_GAME_QUERY_L9_EVENT_LEVEL" + // "SECOND_PASS_POLARIS_RERANKING_EVENT_LEVEL" - Second pass polaris + // reranking event level. + // "SECOND_PASS_POLARIS_WITH_RANKING_CHANGE_EVENT_LEVEL" - Second pass + // polaris with ranking change event level. // "EVENT_LEVEL_TEST_CODE_LIMIT" // "RESERVED_4" // "RESERVED_5" @@ -137758,6 +137577,15 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // "INLINE_DETAILS_CALLER_AQUALITY_CHECK_FAIL_SESSION_LEVEL" // "INLINE_DETAILS_IS_INLINE_URL_SESSION_LEVEL" - Session level test // code indicating external details URL is an inline URL. + // "INLINE_DETAILS_IS_INLINE_URL_FRONTEND_SESSION_LEVEL" - Session + // level test code for Aquality/Tquality filtering in LMD project. This + // is a duplicated testcode created for logging in frontend. + // "INLINE_DETAILS_TQUALITY_CHECK_PASS_FRONTEND_SESSION_LEVEL" + // "INLINE_DETAILS_TQUALITY_CHECK_FAIL_FRONTEND_SESSION_LEVEL" + // "INLINE_DETAILS_AQUALITY_CHECK_PASS_FRONTEND_SESSION_LEVEL" + // "INLINE_DETAILS_AQUALITY_CHECK_FAIL_FRONTEND_SESSION_LEVEL" + // "INLINE_DETAILS_CALLER_AQUALITY_CHECK_PASS_FRONTEND_SESSION_LEVEL" + // "INLINE_DETAILS_CALLER_AQUALITY_CHECK_FAIL_FRONTEND_SESSION_LEVEL" // "SENT_EMAIL_ENTER_GRACE_PERIOD_SESSION_LEVEL" - Session level test // code that indicates that decline email is sent when the subscription // enters grace period. @@ -138022,8 +137850,34 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // Intent Games TimeSpent Session Level. // "ELIGIBLE_FOR_MANAGE_IN_APP_DETAILS_SESSION_LEVEL" - Session level // test code for eligible users for manage in-app details - // "SEE_REENGAGEMENT_ACC_SESSION_LEVEL" - Session level test code for - // users that see reengagement ACC + // "ELIGIBLE_FOR_ACC_SESSION_LEVEL" - Session level test code for + // users are eligible for ACC + // "ELIGIBLE_FOR_ACQUISITION_ACC_SESSION_LEVEL" - Session level test + // code for users are eligible for acquisition ACC + // "ELIGIBLE_FOR_REENGAGEMENT_ACC_SESSION_LEVEL" - Session level test + // code for users are eligible for reengagement ACC + // "MDP_P13N_ALL_SESSION_LEVEL" - MDP P13N + // "MDP_P13N_GAME_QUERY_L5_SESSION_LEVEL" + // "MDP_P13N_GAME_QUERY_L6_SESSION_LEVEL" + // "MDP_P13N_GAME_QUERY_L7_SESSION_LEVEL" + // "MDP_P13N_GAME_QUERY_L8_SESSION_LEVEL" + // "MDP_P13N_GAME_QUERY_L9_SESSION_LEVEL" + // "VIDEO_CAN_AUTOPLAY" - Session level test code to tell if a video + // can autoplay for the given user based on their settings and + // connection status + // "VIDEO_CANNOT_AUTOPLAY" + // "YOUTUBE_OPT_IN_NOTIFICATION_DRIVEN_PREFETCH_SESSION_LEVEL" - + // Session level test code for YouTube commerce, tracking users who opt + // in notification driven prefetch. + // + // "YOUTUBE_COUNTERFACTUAL_OPT_IN_NOTIFICATION_DRIVEN_PREFETCH_SESSION_LE + // VEL" + // "YOUTUBE_NOT_OPT_IN_NOTIFICATION_DRIVEN_PREFETCH_SESSION_LEVEL" + // "YOUTUBE_FROM_LANDING_PAGE_SESSION_LEVEL" + // "SECOND_PASS_POLARIS_RERANKING_SESSION_LEVEL" - Second pass polaris + // reranking session level. + // "SECOND_PASS_POLARIS_WITH_RANKING_CHANGE_SESSION_LEVEL" - Second + // pass polaris with ranking change session level. // "SESSION_LEVEL_TEST_CODE_LIMIT" // "SHOULD_SEE_LIVE_OP_CLUSTER_USER_LEVEL" - User should see the live // op cluster. @@ -138298,6 +138152,7 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_ON_SERP_MDP_USER_LEVEL" // // "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_ON_APP_DETAILS_PAGE_USER_LEVEL" + // "SHOULD_SEE_FIRST_PARTY_PROMO_LIVE_OP_ON_APP_DP_USER_LEVEL" // "CART_ABANDONMENT_SUBSCRIPTION_ONE_TIME_PASS_USER_LEVEL" - User // saw/would have seen the subscription one time pass offer // "LEGOLAND_INSTANT_FOP_SCREEN_USER_LEVEL" - when abandonments the @@ -138673,6 +138528,24 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // "YOUTUBE_OPTED_IN_NOTIFICATION_DRIVEN_PREFETCH_USER_LEVEL" - User // level test code for YouTube commerce, tracking users who opted in // notification driven prefetch. + // "PLAY_ONBOARDING_QUEST_GAMES_HOME_SERVER_USER_LEVEL" - User level + // test code for Play Onboarding quest, tracking users who are eligible + // for Play Onboarding quest in Games Home. This test code is logged on + // the server side. + // "PCH_O2_WITH_CRE_USER_LEVEL" - User level test code for tracking + // users who are being shown PersistentCartHeader through purchase flow. + // This test code is logged on the server side. + // "MERCH_USER_JOURNEY_ROBLOX_SPEND_USER_LEVEL" - User level test code + // for Merch user journey roblox spend experiment. This test code is + // logged on the server side. + // "PBUY_FINE_TUNING_WITH_TEXT_TREAT_USER_LEVEL" - User level test + // code for new uplift modeling architecture with campaign features in + // treatment tower. + // "PLAY_GAMES_ACHIEVEMENT_LOYALTY_QUEST_USER_LEVEL" - User level test + // code for Non-Play Growth Events experiment (go/npge-prd). Logged on + // the server side and applied to users that visit Loyalty Home and are + // eligible to receive a quest with Play Games Achievement tasks, + // regardless of whether the quest was shown or held back. // "USER_LEVEL_TEST_CODE_LIMIT" TestCode []string `json:"testCode,omitempty"` @@ -138706,7 +138579,7 @@ func (s *VendingConsumerProtoTrustedGenomeAnnotation) MarshalJSON() ([]byte, err // VendingConsumerProtoTrustedGenomeEntity: Proto message containing the // id, localized title, score, and hierarchy level of a trusted genome -// entity. +// entity. Next ID: 10 type VendingConsumerProtoTrustedGenomeEntity struct { // CategoryId: The category id matching this trusted genome entity. e.g. // Action tag with id /m/025zzc matches category of id GAME_ACTION @@ -138722,6 +138595,10 @@ type VendingConsumerProtoTrustedGenomeEntity struct { // hierarchy, its level is 1. Required. Level int64 `json:"level,omitempty"` + // PredicateName: The name of the relation between the app and the + // entity. Required. + PredicateName string `json:"predicateName,omitempty"` + // QueryText: The localized query string for this trusted genome entity. // This query will be used when we want to bring users to SERP on click. QueryText string `json:"queryText,omitempty"` @@ -139251,8 +139128,10 @@ type VideoAssetsVenomVideoId struct { // "NS_CONTRIB_SERVICE_SHARED" - Namespace for shared ContribService // UGC videos. // "NS_CONTRIB_SERVICE_GEO_UGC" - Namespace for GEO UGC videos - // processed by ContribService. Please receive approval via - // go/vp-newclients before adding a new namespace. + // processed by ContribService. + // "NS_SEARCH_SPORTS" - Namespace for Search Sports vertical videos. + // Please receive approval via go/vp-newclients before adding a new + // namespace. Ns string `json:"ns,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to @@ -141067,6 +140946,7 @@ type VideoContentSearchFrameStarburstData struct { // SHOPPING_COLOR_INFO_V3 are in the request, SHOPPING_COLOR_INFO_V3's // response is returned. // "SHOPPING_COLOR_INFO_V3_WITHOUT_PER_DOMAIN_OUTPUTS" + // "SHOPPING_COLOR_SAMPLING_V1" // "FOODNET_WIC_V1" - FoodNet whole image classifier versions. // "FOODNET_WIC_V2" // "SINGLE_IMAGE_HOLISTIC_STABLE" - Single Image Holistic versions. @@ -143867,6 +143747,9 @@ type VideoContentSearchVideoAnchor struct { // "GENERATIVE_ASR_V2" - Generative ASR anchors V2. // "SUMMARY_SEGMENT" - Anchors pointing to the conclusion/summary part // of the video. (go/vs-find-summary-segment) + // "OCR_EDU" - OCR and ASR anchors generated for educational videos in + // edu Raffia Overlay. + // "ASR_SPAN_EDU" AnchorType string `json:"anchorType,omitempty"` // ContextText: Context text from ASR of long duration, used for longT5 @@ -144349,6 +144232,9 @@ type VideoContentSearchVideoAnchors struct { // "GENERATIVE_ASR_V2" - Generative ASR anchors V2. // "SUMMARY_SEGMENT" - Anchors pointing to the conclusion/summary part // of the video. (go/vs-find-summary-segment) + // "OCR_EDU" - OCR and ASR anchors generated for educational videos in + // edu Raffia Overlay. + // "ASR_SPAN_EDU" AnchorType string `json:"anchorType,omitempty"` // EntityGroupInfo: The list of entity groups derived from the caption @@ -144449,6 +144335,9 @@ type VideoContentSearchVideoAnchors struct { // "GENERATIVE_ASR_V2" - Generative ASR anchors V2. // "SUMMARY_SEGMENT" - Anchors pointing to the conclusion/summary part // of the video. (go/vs-find-summary-segment) + // "OCR_EDU" - OCR and ASR anchors generated for educational videos in + // edu Raffia Overlay. + // "ASR_SPAN_EDU" MergedAnchorsSources []string `json:"mergedAnchorsSources,omitempty"` // PredictedQuerylessTocUsefulness: The score that predicts the @@ -153972,6 +153861,7 @@ type YoutubeCommentsClusteringMiniStanza struct { // pipeline. IMA SDK // "ANDROID_GVP_ADS" - GMA SDK Android // "IOS_GVP_ADS" - GMA SDK iOS + // "VAST_GVP_ADS" - VAST based SDKs // "GOOGLE_ASSISTANT" - Middleware or Frontend Server Clients Google // Assistant integration with Voz // "GOOGLE_LIST_RECS" - List Recs Service Clients @@ -154890,12 +154780,8 @@ type YoutubeDiscoveryLegosLegosSemanticRelationshipContext struct { // uploaded this video on a channel that they are verified to be related // to, but may not control exclusively go/avg-use-cases // go/artist-channels contact: ytm-classification-eng@google.com - // "TV_SHOW_FOOTAGE" - The entity refers to the TV show that this - // video contains footage of, in a way that is appropriate for watching - // the show itself. A show with commentary voiceover shouldn't get this - // context. Typically determined using ContentID with audiovisual - // matches. This means that a show which is not claimed can't have this - // context. + // "TV_SHOW_FOOTAGE" - Deprecated. The context is currently unused and + // very sparse populated. We plan to delete it. // "TV_SHOW_GENRE" - The entity refers to a TV show genre added from a // TV show annotated on this video. Note that this does not imply that // TV_SHOW_FOOTAGE is present on any annotation for this video; the show @@ -154906,24 +154792,14 @@ type YoutubeDiscoveryLegosLegosSemanticRelationshipContext struct { // shoulder content such as trailers or interviews. // "GAMING_TOP_VIDEO_GAME" - The entity refers to the top scored game // title(s) for a particular gaming related video. - // "GAMING_IS_ITEM_EQUIPPED_BY" - The entity refers to an item equiped - // by some "object" (in the subject-predicate-object sense) in the game - // in this video. This context comes from the game state annotation - // process detailed at go/game-state-annotation-design. - // "GAMING_IS_ITEM_USED_BY" - The entity refers to an item used by - // some "object" (in the subject-predicate-object sense) in the game in - // this video. This context comes from the game state annotation process - // detailed at go/game-state-annotation-design, and an example of its - // generation and meaning is described in go/clash-legos-semantics. - // "GAMING_IS_ALLIED_CHARACTER_OF" - The entity refers to a character - // who is an ally of some "object" (in the subject-predicate-object - // sense) in the game in this video. This context comes from the game - // state annotation process detailed at go/game-state-annotation-design. - // "GAMING_IS_CHARACTER_CONTROLLED_BY" - The entity refers to a - // character who is controlled by some "object" (in the - // subject-predicate-object sense) in the game in this video. This - // context comes from the game state annotation process detailed at - // go/game-state-annotation-design. + // "GAMING_IS_ITEM_EQUIPPED_BY" - Deprecated. The experiment on top of + // this has not launched. + // "GAMING_IS_ITEM_USED_BY" - Deprecated. The experiment on top of + // this has not launched. + // "GAMING_IS_ALLIED_CHARACTER_OF" - Deprecated. The experiment on top + // of this has not launched. + // "GAMING_IS_CHARACTER_CONTROLLED_BY" - Deprecated. The experiment on + // top of this has not launched. // "LEGOS_OVERRIDE_LIVE_SPORTS" - The entity refers to a Legos // annotation that is manually requested by the live discovery team for // sports live streams. @@ -155023,25 +154899,10 @@ type YoutubeDiscoveryLegosLegosSemanticRelationshipContext struct { // individual KG types in YTKS. // "GEO_TYPE" - Context used by Geo that indicates if an entity is a // geo feature. - // "ADDED_DURING_GEO_ENTITIES_PROMOTION" - Deprecated. See - // b/244583433. Instead, consider relying on GEO_TYPE and looking up - // individual KG types in YTKS. - // "GEO_TYPE_COMPOUND_BUILDING" - Deprecated. See b/244583433. - // Instead, consider relying on GEO_TYPE and looking up individual KG - // types in YTKS. - // "GEO_TYPE_POLITICAL" - Deprecated. See b/244583433. Instead, - // consider relying on GEO_TYPE and looking up individual KG types in - // YTKS. // "GEO_TYPES_COLLECTION_SMALL_POLITICALS" - Deprecated. See // b/244583433. Instead, consider relying on GEO_TYPE and looking up // individual KG types in YTKS. - // "GEO_TYPES_COLLECTION_CITY_LEVEL_POLITICALS" - Deprecated. See - // b/244583433. Instead, consider relying on GEO_TYPE and looking up - // individual KG types in YTKS. - // "GEO_TYPES_COLLECTION_LARGE_POLITICALS" - Deprecated. See - // b/244583433. Instead, consider relying on GEO_TYPE and looking up - // individual KG types in YTKS. - // "GEO_TYPES_COLLECTION_NATURAL_FEATURES" - Deprecated. See + // "ADDED_DURING_GEO_ENTITIES_PROMOTION" - Deprecated. See // b/244583433. Instead, consider relying on GEO_TYPE and looking up // individual KG types in YTKS. // "DENORM_LOCATION_TO_CONTAINING_COUNTRY" - Assigned to an entity @@ -158591,6 +158452,154 @@ func (c *ProjectsLocationsDocumentsReferenceIdPatchCall) Do(opts ...googleapi.Ca } +// method id "contentwarehouse.projects.locations.operations.get": + +type ProjectsLocationsOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets the latest state of a long-running operation. Clients can +// use this method to poll the operation result at intervals as +// recommended by the API service. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall { + c := &ProjectsLocationsOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "contentwarehouse.projects.locations.operations.get" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "contentwarehouse.projects.locations.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "contentwarehouse.projects.locations.ruleSets.create": type ProjectsLocationsRuleSetsCreateCall struct { diff --git a/documentai/v1/documentai-api.json b/documentai/v1/documentai-api.json index 2a9cc821927..d5cbb697b62 100644 --- a/documentai/v1/documentai-api.json +++ b/documentai/v1/documentai-api.json @@ -894,7 +894,7 @@ } } }, - "revision": "20221114", + "revision": "20221201", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1955,7 +1955,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1DocumentStyle" }, @@ -2058,7 +2058,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -2106,6 +2106,27 @@ "gcsUri": { "description": "The Cloud Storage uri (a directory) of the output.", "type": "string" + }, + "shardingConfig": { + "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig", + "description": "Specifies the sharding config for the output document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig": { + "description": "The sharding config for the output document.", + "id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig", + "properties": { + "pagesOverlap": { + "description": "The number of overlapping pages between consecutive shards.", + "format": "int32", + "type": "integer" + }, + "pagesPerShard": { + "description": "The number of pages per shard.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -2275,7 +2296,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -2395,7 +2416,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -2910,7 +2931,7 @@ "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \u003e10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." }, "name": { - "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use `snake_casing`* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use `snake_casing`* - name matching is case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", "type": "string" }, "properties": { @@ -3457,6 +3478,13 @@ "description": "The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`", "type": "string" }, + "sampleDocumentUris": { + "description": "A set of Cloud Storage URIs of sample documents for this processor.", + "items": { + "type": "string" + }, + "type": "array" + }, "type": { "description": "The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.", "type": "string" @@ -3885,7 +3913,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" }, @@ -3988,7 +4016,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -4178,7 +4206,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -4298,7 +4326,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -5166,7 +5194,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" }, @@ -5269,7 +5297,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -5479,7 +5507,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -5599,7 +5627,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, diff --git a/documentai/v1/documentai-gen.go b/documentai/v1/documentai-gen.go index b82c2593131..6b0ec6ad70c 100644 --- a/documentai/v1/documentai-gen.go +++ b/documentai/v1/documentai-gen.go @@ -2088,7 +2088,7 @@ type GoogleCloudDocumentaiV1Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -2237,12 +2237,12 @@ type GoogleCloudDocumentaiV1DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -2358,6 +2358,10 @@ type GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig struct { // GcsUri: The Cloud Storage uri (a directory) of the output. GcsUri string `json:"gcsUri,omitempty"` + // ShardingConfig: Specifies the sharding config for the output + // document. + ShardingConfig *GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig `json:"shardingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "FieldMask") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -2381,6 +2385,39 @@ func (s *GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConf +// ig: The sharding config for the output document. +type GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig struct { + // PagesOverlap: The number of overlapping pages between consecutive + // shards. + PagesOverlap int64 `json:"pagesOverlap,omitempty"` + + // PagesPerShard: The number of pages per shard. + PagesPerShard int64 `json:"pagesPerShard,omitempty"` + + // ForceSendFields is a list of field names (e.g. "PagesOverlap") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "PagesOverlap") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1DocumentPage: A page in a Document. type GoogleCloudDocumentaiV1DocumentPage struct { // Blocks: A list of visually detected text blocks on the page. A block @@ -2528,8 +2565,8 @@ type GoogleCloudDocumentaiV1DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -2771,7 +2808,8 @@ type GoogleCloudDocumentaiV1DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -3607,13 +3645,13 @@ type GoogleCloudDocumentaiV1DocumentSchemaEntityType struct { // Name: Name of the type. It must be unique within the schema file and // cannot be a 'Common Type'. Besides that we use the following naming - // conventions: - *use `snake_casing`* - name matching is - // case-insensitive - Maximum 64 characters. - Must start with a letter. - // - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward - // compatibility internal infrastructure and tooling can handle any - // ascii character) - The `/` is sometimes used to denote a property of - // a type. For example `line_item/amount`. This convention is - // deprecated, but will still be honored for backward compatibility. + // conventions: - *use `snake_casing`* - name matching is case-sensitive + // - Maximum 64 characters. - Must start with a letter. - Allowed + // characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility + // internal infrastructure and tooling can handle any ascii character) - + // The `/` is sometimes used to denote a property of a type. For example + // `line_item/amount`. This convention is deprecated, but will still be + // honored for backward compatibility. Name string `json:"name,omitempty"` // Properties: Describing the nested structure, or composition of an @@ -4611,6 +4649,10 @@ type GoogleCloudDocumentaiV1ProcessorType struct { // `projects/{project}/processorTypes/{processor_type}` Name string `json:"name,omitempty"` + // SampleDocumentUris: A set of Cloud Storage URIs of sample documents + // for this processor. + SampleDocumentUris []string `json:"sampleDocumentUris,omitempty"` + // Type: The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, // etc. Type string `json:"type,omitempty"` @@ -5317,7 +5359,7 @@ type GoogleCloudDocumentaiV1beta1Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta1DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta1DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -5466,12 +5508,12 @@ type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -5693,8 +5735,8 @@ type GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -5937,7 +5979,8 @@ type GoogleCloudDocumentaiV1beta1DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -7425,7 +7468,7 @@ type GoogleCloudDocumentaiV1beta2Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta2DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta2DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -7574,12 +7617,12 @@ type GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -7856,8 +7899,8 @@ type GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -8100,7 +8143,8 @@ type GoogleCloudDocumentaiV1beta2DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to diff --git a/documentai/v1beta2/documentai-api.json b/documentai/v1beta2/documentai-api.json index 91c9e6a1735..839cdcd18f7 100644 --- a/documentai/v1beta2/documentai-api.json +++ b/documentai/v1beta2/documentai-api.json @@ -292,7 +292,7 @@ } } }, - "revision": "20221114", + "revision": "20221201", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1505,7 +1505,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" }, @@ -1608,7 +1608,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -1798,7 +1798,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -1918,7 +1918,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -2811,7 +2811,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" }, @@ -2914,7 +2914,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -3124,7 +3124,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -3244,7 +3244,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, diff --git a/documentai/v1beta2/documentai-gen.go b/documentai/v1beta2/documentai-gen.go index 47a9e74795d..b8856c498d3 100644 --- a/documentai/v1beta2/documentai-gen.go +++ b/documentai/v1beta2/documentai-gen.go @@ -2318,7 +2318,7 @@ type GoogleCloudDocumentaiV1beta1Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta1DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta1DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -2467,12 +2467,12 @@ type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -2694,8 +2694,8 @@ type GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -2938,7 +2938,8 @@ type GoogleCloudDocumentaiV1beta1DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -4486,7 +4487,7 @@ type GoogleCloudDocumentaiV1beta2Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta2DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta2DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -4639,12 +4640,12 @@ type GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -4921,8 +4922,8 @@ type GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -5165,7 +5166,8 @@ type GoogleCloudDocumentaiV1beta2DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to diff --git a/documentai/v1beta3/documentai-api.json b/documentai/v1beta3/documentai-api.json index 7dfdca29e5c..622947bf586 100644 --- a/documentai/v1beta3/documentai-api.json +++ b/documentai/v1beta3/documentai-api.json @@ -959,7 +959,7 @@ } } }, - "revision": "20221114", + "revision": "20221201", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -2172,7 +2172,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" }, @@ -2275,7 +2275,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -2465,7 +2465,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -2585,7 +2585,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -3453,7 +3453,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" }, @@ -3556,7 +3556,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -3766,7 +3766,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -3886,7 +3886,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -4771,6 +4771,10 @@ "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig", "description": "The overall output config for batch process." }, + "processOptions": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessOptions", + "description": "Inference-time options for the process API" + }, "skipHumanReview": { "description": "Whether Human Review feature should be skipped for this request. Default to false.", "type": "boolean" @@ -5005,7 +5009,7 @@ "type": "array" }, "textStyles": { - "description": "Placeholder. Styles for the Document.text.", + "description": "Styles for the Document.text.", "items": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentStyle" }, @@ -5108,7 +5112,7 @@ "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, @@ -5156,6 +5160,27 @@ "gcsUri": { "description": "The Cloud Storage uri (a directory) of the output.", "type": "string" + }, + "shardingConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig", + "description": "Specifies the sharding config for the output document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig": { + "description": "The sharding config for the output document.", + "id": "GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig", + "properties": { + "pagesOverlap": { + "description": "The number of overlapping pages between consecutive shards.", + "format": "int32", + "type": "integer" + }, + "pagesPerShard": { + "description": "The number of pages per shard.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -5325,7 +5350,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "format": "int64", "type": "string" } @@ -5445,7 +5470,7 @@ "type": "array" }, "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, @@ -5960,7 +5985,7 @@ "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \u003e10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." }, "name": { - "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use `snake_casing`* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use `snake_casing`* - name matching is case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", "type": "string" }, "properties": { @@ -6606,6 +6631,28 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3OcrConfig": { + "description": "Config for Document OCR.", + "id": "GoogleCloudDocumentaiV1beta3OcrConfig", + "properties": { + "enableNativePdfParsing": { + "description": "Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessOptions": { + "description": "Options for Process API", + "id": "GoogleCloudDocumentaiV1beta3ProcessOptions", + "properties": { + "ocrConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3OcrConfig", + "description": "Only applicable to \"Document OCR Processor\". Returns error if set on other processor types." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ProcessRequest": { "description": "Request message for the process document method.", "id": "GoogleCloudDocumentaiV1beta3ProcessRequest", @@ -6623,6 +6670,10 @@ "$ref": "GoogleCloudDocumentaiV1beta3Document", "description": "An inline document proto." }, + "processOptions": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessOptions", + "description": "Inference-time options for the process API" + }, "rawDocument": { "$ref": "GoogleCloudDocumentaiV1beta3RawDocument", "description": "A raw document content (bytes)." @@ -6763,6 +6814,13 @@ "description": "The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`", "type": "string" }, + "sampleDocumentUris": { + "description": "A set of Cloud Storage URIs of sample documents for this processor.", + "items": { + "type": "string" + }, + "type": "array" + }, "type": { "description": "The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.", "type": "string" diff --git a/documentai/v1beta3/documentai-gen.go b/documentai/v1beta3/documentai-gen.go index 1c0924f6f33..184bebfec1b 100644 --- a/documentai/v1beta3/documentai-gen.go +++ b/documentai/v1beta3/documentai-gen.go @@ -2342,7 +2342,7 @@ type GoogleCloudDocumentaiV1beta1Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta1DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta1DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -2491,12 +2491,12 @@ type GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -2718,8 +2718,8 @@ type GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -2962,7 +2962,8 @@ type GoogleCloudDocumentaiV1beta1DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -4450,7 +4451,7 @@ type GoogleCloudDocumentaiV1beta2Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta2DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta2DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -4599,12 +4600,12 @@ type GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -4881,8 +4882,8 @@ type GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -5125,7 +5126,8 @@ type GoogleCloudDocumentaiV1beta2DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -6663,6 +6665,9 @@ type GoogleCloudDocumentaiV1beta3BatchProcessRequest struct { // OutputConfig: The overall output config for batch process. OutputConfig *GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig `json:"outputConfig,omitempty"` + // ProcessOptions: Inference-time options for the process API + ProcessOptions *GoogleCloudDocumentaiV1beta3ProcessOptions `json:"processOptions,omitempty"` + // SkipHumanReview: Whether Human Review feature should be skipped for // this request. Default to false. SkipHumanReview bool `json:"skipHumanReview,omitempty"` @@ -7034,7 +7039,7 @@ type GoogleCloudDocumentaiV1beta3Document struct { // other. TextChanges []*GoogleCloudDocumentaiV1beta3DocumentTextChange `json:"textChanges,omitempty"` - // TextStyles: Placeholder. Styles for the Document.text. + // TextStyles: Styles for the Document.text. TextStyles []*GoogleCloudDocumentaiV1beta3DocumentStyle `json:"textStyles,omitempty"` // Uri: Optional. Currently supports Google Cloud Storage URI of the @@ -7183,12 +7188,12 @@ type GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue struct { // Text: Optional. An optional field to store a normalized string. For // some entity types, one of respective `structured_value` fields may // also be populated. Also not all the types of `structured_value` will - // be normalized. For example, some processors may not generate float or - // int normalized text by default. Below are sample formats mapped to - // structured values. - Money/Currency type (`money_value`) is in the - // ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 - // text format. - Datetime type (`datetime_value`) is in the ISO 8601 - // text format. + // be normalized. For example, some processors may not generate `float` + // or `integer` normalized text by default. Below are sample formats + // mapped to structured values. - Money/Currency type (`money_value`) is + // in the ISO 4217 text format. - Date type (`date_value`) is in the ISO + // 8601 text format. - Datetime type (`datetime_value`) is in the ISO + // 8601 text format. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "AddressValue") to @@ -7305,6 +7310,10 @@ type GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig struct { // GcsUri: The Cloud Storage uri (a directory) of the output. GcsUri string `json:"gcsUri,omitempty"` + // ShardingConfig: Specifies the sharding config for the output + // document. + ShardingConfig *GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig `json:"shardingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "FieldMask") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -7328,6 +7337,39 @@ func (s *GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig) Marsha return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardin +// gConfig: The sharding config for the output document. +type GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig struct { + // PagesOverlap: The number of overlapping pages between consecutive + // shards. + PagesOverlap int64 `json:"pagesOverlap,omitempty"` + + // PagesPerShard: The number of pages per shard. + PagesPerShard int64 `json:"pagesPerShard,omitempty"` + + // ForceSendFields is a list of field names (e.g. "PagesOverlap") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "PagesOverlap") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3DocumentPage: A page in a Document. type GoogleCloudDocumentaiV1beta3DocumentPage struct { // Blocks: A list of visually detected text blocks on the page. A block @@ -7475,8 +7517,8 @@ type GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef struct { LayoutType string `json:"layoutType,omitempty"` // Page: Required. Index into the Document.pages element, for example - // using Document.pages to locate the related page element. This field - // is skipped when its value is the default 0. See + // using `Document.pages` to locate the related page element. This field + // is skipped when its value is the default `0`. See // https://developers.google.com/protocol-buffers/docs/proto3#json. Page int64 `json:"page,omitempty,string"` @@ -7719,7 +7761,8 @@ type GoogleCloudDocumentaiV1beta3DocumentPageFormField struct { // ValueType: If the value is non-textual, this field represents the // type. Current valid values are: - blank (this indicates the - // field_value is normal text) - "unfilled_checkbox" - "filled_checkbox" + // `field_value` is normal text) - `unfilled_checkbox` - + // `filled_checkbox` ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "CorrectedKeyText") to @@ -8555,13 +8598,13 @@ type GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType struct { // Name: Name of the type. It must be unique within the schema file and // cannot be a 'Common Type'. Besides that we use the following naming - // conventions: - *use `snake_casing`* - name matching is - // case-insensitive - Maximum 64 characters. - Must start with a letter. - // - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward - // compatibility internal infrastructure and tooling can handle any - // ascii character) - The `/` is sometimes used to denote a property of - // a type. For example `line_item/amount`. This convention is - // deprecated, but will still be honored for backward compatibility. + // conventions: - *use `snake_casing`* - name matching is case-sensitive + // - Maximum 64 characters. - Must start with a letter. - Allowed + // characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility + // internal infrastructure and tooling can handle any ascii character) - + // The `/` is sometimes used to denote a property of a type. For example + // `line_item/amount`. This convention is deprecated, but will still be + // honored for backward compatibility. Name string `json:"name,omitempty"` // Properties: Describing the nested structure, or composition of an @@ -9779,6 +9822,67 @@ func (s *GoogleCloudDocumentaiV1beta3NormalizedVertex) UnmarshalJSON(data []byte return nil } +// GoogleCloudDocumentaiV1beta3OcrConfig: Config for Document OCR. +type GoogleCloudDocumentaiV1beta3OcrConfig struct { + // EnableNativePdfParsing: Enables special handling for PDFs with + // existing text information. Results in better text extraction quality + // in such PDF inputs. + EnableNativePdfParsing bool `json:"enableNativePdfParsing,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EnableNativePdfParsing") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EnableNativePdfParsing") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3OcrConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3OcrConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiV1beta3ProcessOptions: Options for Process API +type GoogleCloudDocumentaiV1beta3ProcessOptions struct { + // OcrConfig: Only applicable to "Document OCR Processor". Returns error + // if set on other processor types. + OcrConfig *GoogleCloudDocumentaiV1beta3OcrConfig `json:"ocrConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OcrConfig") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "OcrConfig") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3ProcessOptions) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3ProcessOptions + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiV1beta3ProcessRequest: Request message for the // process document method. type GoogleCloudDocumentaiV1beta3ProcessRequest struct { @@ -9795,6 +9899,9 @@ type GoogleCloudDocumentaiV1beta3ProcessRequest struct { // InlineDocument: An inline document proto. InlineDocument *GoogleCloudDocumentaiV1beta3Document `json:"inlineDocument,omitempty"` + // ProcessOptions: Inference-time options for the process API + ProcessOptions *GoogleCloudDocumentaiV1beta3ProcessOptions `json:"processOptions,omitempty"` + // RawDocument: A raw document content (bytes). RawDocument *GoogleCloudDocumentaiV1beta3RawDocument `json:"rawDocument,omitempty"` @@ -10009,6 +10116,10 @@ type GoogleCloudDocumentaiV1beta3ProcessorType struct { // `projects/{project}/processorTypes/{processor_type}` Name string `json:"name,omitempty"` + // SampleDocumentUris: A set of Cloud Storage URIs of sample documents + // for this processor. + SampleDocumentUris []string `json:"sampleDocumentUris,omitempty"` + // Type: The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, // etc. Type string `json:"type,omitempty"` diff --git a/healthcare/v1/healthcare-api.json b/healthcare/v1/healthcare-api.json index 300b3c69401..1bf0e78e3f1 100644 --- a/healthcare/v1/healthcare-api.json +++ b/healthcare/v1/healthcare-api.json @@ -3254,7 +3254,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -3282,7 +3282,7 @@ ] }, "search-type": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -4053,7 +4053,7 @@ } } }, - "revision": "20221027", + "revision": "20221122", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -4819,7 +4819,7 @@ "type": "number" }, "linkedEntities": { - "description": "linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence.it", + "description": "linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence.", "items": { "$ref": "LinkedEntity" }, diff --git a/healthcare/v1/healthcare-gen.go b/healthcare/v1/healthcare-gen.go index f0b87c0893d..0bab962b7a8 100644 --- a/healthcare/v1/healthcare-gen.go +++ b/healthcare/v1/healthcare-gen.go @@ -1823,7 +1823,7 @@ type EntityMention struct { // LinkedEntities: linked_entities are candidate ontological concepts // that this entity mention may refer to. They are sorted by decreasing - // confidence.it + // confidence. LinkedEntities []*LinkedEntity `json:"linkedEntities,omitempty"` // MentionId: mention_id uniquely identifies each entity mention in a @@ -21452,19 +21452,19 @@ type ProjectsLocationsDatasetsFhirStoresFhirSearchCall struct { // FHIR search parameters for DSTU2 can be found on each resource's // definition page. Supported search modifiers: `:missing`, `:exact`, // `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, -// `:[type]`, `:not`, and `:recurse`. Supported search result -// parameters: `_sort`, `_count`, `_include`, `_revinclude`, -// `_summary=text`, `_summary=data`, and `_elements`. The maximum number -// of search results returned defaults to 100, which can be overridden -// by the `_count` parameter up to a maximum limit of 1000. If there are -// additional results, the returned `Bundle` contains a link of -// `relation` "next", which has a `_page_token` parameter for an opaque -// pagination token that can be used to retrieve the next page. -// Resources with a total size larger than 5MB or a field count larger -// than 50,000 might not be fully searchable as the server might trim -// its generated search index in those cases. Note: FHIR resources are -// indexed asynchronously, so there might be a slight delay between the -// time a resource is created or changes and when the change is +// `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). +// Supported search result parameters: `_sort`, `_count`, `_include`, +// `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The +// maximum number of search results returned defaults to 100, which can +// be overridden by the `_count` parameter up to a maximum limit of +// 1000. If there are additional results, the returned `Bundle` contains +// a link of `relation` "next", which has a `_page_token` parameter for +// an opaque pagination token that can be used to retrieve the next +// page. Resources with a total size larger than 5MB or a field count +// larger than 50,000 might not be fully searchable as the server might +// trim its generated search index in those cases. Note: FHIR resources +// are indexed asynchronously, so there might be a slight delay between +// the time a resource is created or changes and when the change is // reflected in search results. For samples and detailed information, // see Searching for FHIR resources // (https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and @@ -21537,7 +21537,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Do(opts ...googleapi gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -21614,19 +21614,19 @@ type ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall struct { // FHIR search parameters for DSTU2 can be found on each resource's // definition page. Supported search modifiers: `:missing`, `:exact`, // `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, -// `:[type]`, `:not`, and `:recurse`. Supported search result -// parameters: `_sort`, `_count`, `_include`, `_revinclude`, -// `_summary=text`, `_summary=data`, and `_elements`. The maximum number -// of search results returned defaults to 100, which can be overridden -// by the `_count` parameter up to a maximum limit of 1000. If there are -// additional results, the returned `Bundle` contains a link of -// `relation` "next", which has a `_page_token` parameter for an opaque -// pagination token that can be used to retrieve the next page. -// Resources with a total size larger than 5MB or a field count larger -// than 50,000 might not be fully searchable as the server might trim -// its generated search index in those cases. Note: FHIR resources are -// indexed asynchronously, so there might be a slight delay between the -// time a resource is created or changes and when the change is +// `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). +// Supported search result parameters: `_sort`, `_count`, `_include`, +// `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The +// maximum number of search results returned defaults to 100, which can +// be overridden by the `_count` parameter up to a maximum limit of +// 1000. If there are additional results, the returned `Bundle` contains +// a link of `relation` "next", which has a `_page_token` parameter for +// an opaque pagination token that can be used to retrieve the next +// page. Resources with a total size larger than 5MB or a field count +// larger than 50,000 might not be fully searchable as the server might +// trim its generated search index in those cases. Note: FHIR resources +// are indexed asynchronously, so there might be a slight delay between +// the time a resource is created or changes and when the change is // reflected in search results. For samples and detailed information, // see Searching for FHIR resources // (https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and @@ -21708,7 +21708,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Do(opts ...googl gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", diff --git a/healthcare/v1beta1/healthcare-api.json b/healthcare/v1beta1/healthcare-api.json index f62d433db01..7bc67dca1cb 100644 --- a/healthcare/v1beta1/healthcare-api.json +++ b/healthcare/v1beta1/healthcare-api.json @@ -4014,7 +4014,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -4042,7 +4042,7 @@ ] }, "search-type": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -4865,7 +4865,7 @@ } } }, - "revision": "20221027", + "revision": "20221122", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "Action": { @@ -5947,7 +5947,7 @@ "type": "number" }, "linkedEntities": { - "description": "linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence.it", + "description": "linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence.", "items": { "$ref": "LinkedEntity" }, diff --git a/healthcare/v1beta1/healthcare-gen.go b/healthcare/v1beta1/healthcare-gen.go index c4a5cb1094d..0655404c994 100644 --- a/healthcare/v1beta1/healthcare-gen.go +++ b/healthcare/v1beta1/healthcare-gen.go @@ -2417,7 +2417,7 @@ type EntityMention struct { // LinkedEntities: linked_entities are candidate ontological concepts // that this entity mention may refer to. They are sorted by decreasing - // confidence.it + // confidence. LinkedEntities []*LinkedEntity `json:"linkedEntities,omitempty"` // MentionId: mention_id uniquely identifies each entity mention in a @@ -27020,19 +27020,19 @@ type ProjectsLocationsDatasetsFhirStoresFhirSearchCall struct { // FHIR search parameters for DSTU2 can be found on each resource's // definition page. Supported search modifiers: `:missing`, `:exact`, // `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, -// `:[type]`, `:not`, and `:recurse`. Supported search result -// parameters: `_sort`, `_count`, `_include`, `_revinclude`, -// `_summary=text`, `_summary=data`, and `_elements`. The maximum number -// of search results returned defaults to 100, which can be overridden -// by the `_count` parameter up to a maximum limit of 1000. If there are -// additional results, the returned `Bundle` contains a link of -// `relation` "next", which has a `_page_token` parameter for an opaque -// pagination token that can be used to retrieve the next page. -// Resources with a total size larger than 5MB or a field count larger -// than 50,000 might not be fully searchable as the server might trim -// its generated search index in those cases. Note: FHIR resources are -// indexed asynchronously, so there might be a slight delay between the -// time a resource is created or changes and when the change is +// `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). +// Supported search result parameters: `_sort`, `_count`, `_include`, +// `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The +// maximum number of search results returned defaults to 100, which can +// be overridden by the `_count` parameter up to a maximum limit of +// 1000. If there are additional results, the returned `Bundle` contains +// a link of `relation` "next", which has a `_page_token` parameter for +// an opaque pagination token that can be used to retrieve the next +// page. Resources with a total size larger than 5MB or a field count +// larger than 50,000 might not be fully searchable as the server might +// trim its generated search index in those cases. Note: FHIR resources +// are indexed asynchronously, so there might be a slight delay between +// the time a resource is created or changes and when the change is // reflected in search results. For samples and detailed information, // see Searching for FHIR resources // (https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and @@ -27105,7 +27105,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Do(opts ...googleapi gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -27183,19 +27183,19 @@ type ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall struct { // FHIR search parameters for DSTU2 can be found on each resource's // definition page. Supported search modifiers: `:missing`, `:exact`, // `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, -// `:[type]`, `:not`, and `:recurse`. Supported search result -// parameters: `_sort`, `_count`, `_include`, `_revinclude`, -// `_summary=text`, `_summary=data`, and `_elements`. The maximum number -// of search results returned defaults to 100, which can be overridden -// by the `_count` parameter up to a maximum limit of 1000. If there are -// additional results, the returned `Bundle` contains a link of -// `relation` "next", which has a `_page_token` parameter for an opaque -// pagination token that can be used to retrieve the next page. -// Resources with a total size larger than 5MB or a field count larger -// than 50,000 might not be fully searchable as the server might trim -// its generated search index in those cases. Note: FHIR resources are -// indexed asynchronously, so there might be a slight delay between the -// time a resource is created or changes and when the change is +// `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). +// Supported search result parameters: `_sort`, `_count`, `_include`, +// `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The +// maximum number of search results returned defaults to 100, which can +// be overridden by the `_count` parameter up to a maximum limit of +// 1000. If there are additional results, the returned `Bundle` contains +// a link of `relation` "next", which has a `_page_token` parameter for +// an opaque pagination token that can be used to retrieve the next +// page. Resources with a total size larger than 5MB or a field count +// larger than 50,000 might not be fully searchable as the server might +// trim its generated search index in those cases. Note: FHIR resources +// are indexed asynchronously, so there might be a slight delay between +// the time a resource is created or changes and when the change is // reflected in search results. For samples and detailed information, // see Searching for FHIR resources // (https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and @@ -27278,7 +27278,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Do(opts ...googl gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + // "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", diff --git a/monitoring/v1/monitoring-api.json b/monitoring/v1/monitoring-api.json index b324ce17c2d..03a95daf9da 100644 --- a/monitoring/v1/monitoring-api.json +++ b/monitoring/v1/monitoring-api.json @@ -769,7 +769,7 @@ } } }, - "revision": "20221107", + "revision": "20221205", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1713,7 +1713,7 @@ "description": "Will cause the scorecard to show a spark chart." }, "thresholds": { - "description": "The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', }Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.", + "description": "The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.", "items": { "$ref": "Threshold" }, diff --git a/monitoring/v1/monitoring-gen.go b/monitoring/v1/monitoring-gen.go index b0043b472dd..58ffdc72196 100644 --- a/monitoring/v1/monitoring-gen.go +++ b/monitoring/v1/monitoring-gen.go @@ -2020,7 +2020,7 @@ type Scorecard struct { // following four thresholds: { value: 90, category: 'DANGER', trigger: // 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { // value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, - // category: 'WARNING', trigger: 'BELOW', }Then: values less than or + // category: 'WARNING', trigger: 'BELOW', } Then: values less than or // equal to 10 would put the scorecard in a DANGER state, values greater // than 10 but less than or equal to 20 a WARNING state, values strictly // between 20 and 70 an OK state, values greater than or equal to 70 but diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json index 10d4cee622e..0d09fc55656 100644 --- a/monitoring/v3/monitoring-api.json +++ b/monitoring/v3/monitoring-api.json @@ -1647,6 +1647,144 @@ } } }, + "snoozes": { + "methods": { + "create": { + "description": "Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.", + "flatPath": "v3/projects/{projectsId}/snoozes", + "httpMethod": "POST", + "id": "monitoring.projects.snoozes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which a Snooze should be created. The format is: projects/[PROJECT_ID_OR_NUMBER] ", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/snoozes", + "request": { + "$ref": "Snooze" + }, + "response": { + "$ref": "Snooze" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring" + ] + }, + "get": { + "description": "Retrieves a Snooze by name.", + "flatPath": "v3/projects/{projectsId}/snoozes/{snoozesId}", + "httpMethod": "GET", + "id": "monitoring.projects.snoozes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The ID of the Snooze to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] ", + "location": "path", + "pattern": "^projects/[^/]+/snoozes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "Snooze" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ] + }, + "list": { + "description": "Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.", + "flatPath": "v3/projects/{projectsId}/snoozes", + "httpMethod": "GET", + "id": "monitoring.projects.snoozes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time \u003e \"2022-03-11T00:00:00-08:00\" AND interval.end_time \u003c \"2022-03-12T00:00:00-08:00\" ``` ", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range 1, 1000. If the value given is outside this range, the server will decide the number of results to be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] ", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/snoozes", + "response": { + "$ref": "ListSnoozesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ] + }, + "patch": { + "description": "Updates a Snooze, identified by its name, with the parameters in the given Snooze object.", + "flatPath": "v3/projects/{projectsId}/snoozes/{snoozesId}", + "httpMethod": "PATCH", + "id": "monitoring.projects.snoozes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", + "location": "path", + "pattern": "^projects/[^/]+/snoozes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The fields to update.For each field listed in update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze. If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.Fields not listed retain their existing value.The following are the field names that are accepted in update_mask: display_name interval.start_time interval.end_timeThat said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "Snooze" + }, + "response": { + "$ref": "Snooze" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring" + ] + } + } + }, "timeSeries": { "methods": { "create": { @@ -2576,7 +2714,7 @@ } } }, - "revision": "20221114", + "revision": "20221205", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3191,6 +3329,20 @@ }, "type": "object" }, + "Criteria": { + "description": "Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied.", + "id": "Criteria", + "properties": { + "policies": { + "description": "The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 10 policies per snooze. This limit is checked during snooze creation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Custom": { "description": "Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.", "id": "Custom", @@ -3479,6 +3631,18 @@ }, "type": "object" }, + "ForecastOptions": { + "description": "Options used when forecasting the time series and testing the predicted value against the threshold.", + "id": "ForecastOptions", + "properties": { + "forecastHorizon": { + "description": "Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "GetNotificationChannelVerificationCodeRequest": { "description": "The GetNotificationChannelVerificationCode request.", "id": "GetNotificationChannelVerificationCodeRequest", @@ -4061,6 +4225,24 @@ }, "type": "object" }, + "ListSnoozesResponse": { + "description": "The results of a successful ListSnoozes call, containing the matching Snoozes.", + "id": "ListSnoozesResponse", + "properties": { + "nextPageToken": { + "description": "Page token for repeated calls to ListSnoozes, to fetch additional pages of results. If this is empty or missing, there are no more pages.", + "type": "string" + }, + "snoozes": { + "description": "Snoozes matching this list call.", + "items": { + "$ref": "Snooze" + }, + "type": "array" + } + }, + "type": "object" + }, "ListTimeSeriesResponse": { "description": "The ListTimeSeries response.", "id": "ListTimeSeriesResponse", @@ -4445,6 +4627,10 @@ "description": "Required. A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.", "type": "string" }, + "forecastOptions": { + "$ref": "ForecastOptions", + "description": "When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizion. When this field is not set, the MetricThreshold tests the current value of the timeseries against the threshold." + }, "thresholdValue": { "description": "A value against which to compare the time series.", "format": "double", @@ -5166,6 +5352,29 @@ }, "type": "object" }, + "Snooze": { + "description": "A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time.", + "id": "Snooze", + "properties": { + "criteria": { + "$ref": "Criteria", + "description": "Required. This defines the criteria for applying the Snooze. See Criteria for more information." + }, + "displayName": { + "description": "Required. A display name for the Snooze. This can be, at most, 512 unicode characters.", + "type": "string" + }, + "interval": { + "$ref": "TimeInterval", + "description": "Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI." + }, + "name": { + "description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", + "type": "string" + } + }, + "type": "object" + }, "SourceContext": { "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.", "id": "SourceContext", diff --git a/monitoring/v3/monitoring-gen.go b/monitoring/v3/monitoring-gen.go index 116d48c9ea6..c1f886606c8 100644 --- a/monitoring/v3/monitoring-gen.go +++ b/monitoring/v3/monitoring-gen.go @@ -220,6 +220,7 @@ func NewProjectsService(s *Service) *ProjectsService { rs.MonitoredResourceDescriptors = NewProjectsMonitoredResourceDescriptorsService(s) rs.NotificationChannelDescriptors = NewProjectsNotificationChannelDescriptorsService(s) rs.NotificationChannels = NewProjectsNotificationChannelsService(s) + rs.Snoozes = NewProjectsSnoozesService(s) rs.TimeSeries = NewProjectsTimeSeriesService(s) rs.UptimeCheckConfigs = NewProjectsUptimeCheckConfigsService(s) return rs @@ -242,6 +243,8 @@ type ProjectsService struct { NotificationChannels *ProjectsNotificationChannelsService + Snoozes *ProjectsSnoozesService + TimeSeries *ProjectsTimeSeriesService UptimeCheckConfigs *ProjectsUptimeCheckConfigsService @@ -322,6 +325,15 @@ type ProjectsNotificationChannelsService struct { s *Service } +func NewProjectsSnoozesService(s *Service) *ProjectsSnoozesService { + rs := &ProjectsSnoozesService{s: s} + return rs +} + +type ProjectsSnoozesService struct { + s *Service +} + func NewProjectsTimeSeriesService(s *Service) *ProjectsTimeSeriesService { rs := &ProjectsTimeSeriesService{s: s} return rs @@ -1602,6 +1614,40 @@ func (s *CreateTimeSeriesSummary) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Criteria: Criteria specific to the AlertPolicys that this Snooze +// applies to. The Snooze will suppress alerts that come from one of the +// AlertPolicys whose names are supplied. +type Criteria struct { + // Policies: The specific AlertPolicy names for the alert that should be + // snoozed. The format is: + // projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a + // limit of 10 policies per snooze. This limit is checked during snooze + // creation. + Policies []string `json:"policies,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Policies") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Policies") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Criteria) MarshalJSON() ([]byte, error) { + type NoMethod Criteria + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Custom: Use a custom service to designate a service that you want to // monitor when none of the other service types (like App Engine, Cloud // Run, or a GKE type) matches your intended service. @@ -2102,6 +2148,40 @@ func (s *Field) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ForecastOptions: Options used when forecasting the time series and +// testing the predicted value against the threshold. +type ForecastOptions struct { + // ForecastHorizon: Required. The length of time into the future to + // forecast whether a time series will violate the threshold. If the + // predicted value is found to violate the threshold, and the violation + // is observed in all forecasts made for the configured duration, then + // the time series is considered to be failing. + ForecastHorizon string `json:"forecastHorizon,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ForecastHorizon") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ForecastHorizon") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ForecastOptions) MarshalJSON() ([]byte, error) { + type NoMethod ForecastOptions + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GetNotificationChannelVerificationCodeRequest: The // GetNotificationChannelVerificationCode request. type GetNotificationChannelVerificationCodeRequest struct { @@ -3250,6 +3330,44 @@ func (s *ListServicesResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ListSnoozesResponse: The results of a successful ListSnoozes call, +// containing the matching Snoozes. +type ListSnoozesResponse struct { + // NextPageToken: Page token for repeated calls to ListSnoozes, to fetch + // additional pages of results. If this is empty or missing, there are + // no more pages. + NextPageToken string `json:"nextPageToken,omitempty"` + + // Snoozes: Snoozes matching this list call. + Snoozes []*Snooze `json:"snoozes,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "NextPageToken") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "NextPageToken") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListSnoozesResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListSnoozesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ListTimeSeriesResponse: The ListTimeSeries response. type ListTimeSeriesResponse struct { // ExecutionErrors: Query execution errors that may have caused the time @@ -3972,6 +4090,13 @@ type MetricThreshold struct { // labels. This field must not exceed 2048 Unicode characters in length. Filter string `json:"filter,omitempty"` + // ForecastOptions: When this field is present, the MetricThreshold + // condition forecasts whether the time series is predicted to violate + // the threshold within the forecast_horizion. When this field is not + // set, the MetricThreshold tests the current value of the timeseries + // against the threshold. + ForecastOptions *ForecastOptions `json:"forecastOptions,omitempty"` + // ThresholdValue: A value against which to compare the time series. ThresholdValue float64 `json:"thresholdValue,omitempty"` @@ -5307,6 +5432,57 @@ func (s *ServiceLevelObjective) UnmarshalJSON(data []byte) error { return nil } +// Snooze: A Snooze will prevent any alerts from being opened, and close +// any that are already open. The Snooze will work on alerts that match +// the criteria defined in the Snooze. The Snooze will be active from +// interval.start_time through interval.end_time. +type Snooze struct { + // Criteria: Required. This defines the criteria for applying the + // Snooze. See Criteria for more information. + Criteria *Criteria `json:"criteria,omitempty"` + + // DisplayName: Required. A display name for the Snooze. This can be, at + // most, 512 unicode characters. + DisplayName string `json:"displayName,omitempty"` + + // Interval: Required. The Snooze will be active from + // interval.start_time through interval.end_time. interval.start_time + // cannot be in the past. There is a 15 second clock skew to account for + // the time it takes for a request to reach the API from the UI. + Interval *TimeInterval `json:"interval,omitempty"` + + // Name: Required. The name of the Snooze. The format is: + // projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the + // Snooze will be generated by the system. + Name string `json:"name,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Criteria") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Criteria") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Snooze) MarshalJSON() ([]byte, error) { + type NoMethod Snooze + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // SourceContext: SourceContext represents information about the source // of a protobuf element, like the file in which it is defined. type SourceContext struct { @@ -13265,6 +13441,691 @@ func (c *ProjectsNotificationChannelsVerifyCall) Do(opts ...googleapi.CallOption } +// method id "monitoring.projects.snoozes.create": + +type ProjectsSnoozesCreateCall struct { + s *Service + parent string + snooze *Snooze + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Creates a Snooze that will prevent alerts, which match the +// provided criteria, from being opened. The Snooze applies for a +// specific time interval. +// +// - parent: The project +// (https://cloud.google.com/monitoring/api/v3#project_name) in which +// a Snooze should be created. The format is: +// projects/[PROJECT_ID_OR_NUMBER]. +func (r *ProjectsSnoozesService) Create(parent string, snooze *Snooze) *ProjectsSnoozesCreateCall { + c := &ProjectsSnoozesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.snooze = snooze + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsSnoozesCreateCall) Fields(s ...googleapi.Field) *ProjectsSnoozesCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsSnoozesCreateCall) Context(ctx context.Context) *ProjectsSnoozesCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsSnoozesCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSnoozesCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.snooze) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+parent}/snoozes") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "monitoring.projects.snoozes.create" call. +// Exactly one of *Snooze or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Snooze.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsSnoozesCreateCall) Do(opts ...googleapi.CallOption) (*Snooze, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Snooze{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.", + // "flatPath": "v3/projects/{projectsId}/snoozes", + // "httpMethod": "POST", + // "id": "monitoring.projects.snoozes.create", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "parent": { + // "description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which a Snooze should be created. The format is: projects/[PROJECT_ID_OR_NUMBER] ", + // "location": "path", + // "pattern": "^projects/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v3/{+parent}/snoozes", + // "request": { + // "$ref": "Snooze" + // }, + // "response": { + // "$ref": "Snooze" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/monitoring" + // ] + // } + +} + +// method id "monitoring.projects.snoozes.get": + +type ProjectsSnoozesGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Retrieves a Snooze by name. +// +// - name: The ID of the Snooze to retrieve. The format is: +// projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]. +func (r *ProjectsSnoozesService) Get(name string) *ProjectsSnoozesGetCall { + c := &ProjectsSnoozesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsSnoozesGetCall) Fields(s ...googleapi.Field) *ProjectsSnoozesGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsSnoozesGetCall) IfNoneMatch(entityTag string) *ProjectsSnoozesGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsSnoozesGetCall) Context(ctx context.Context) *ProjectsSnoozesGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsSnoozesGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSnoozesGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "monitoring.projects.snoozes.get" call. +// Exactly one of *Snooze or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Snooze.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsSnoozesGetCall) Do(opts ...googleapi.CallOption) (*Snooze, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Snooze{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieves a Snooze by name.", + // "flatPath": "v3/projects/{projectsId}/snoozes/{snoozesId}", + // "httpMethod": "GET", + // "id": "monitoring.projects.snoozes.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The ID of the Snooze to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] ", + // "location": "path", + // "pattern": "^projects/[^/]+/snoozes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v3/{+name}", + // "response": { + // "$ref": "Snooze" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/monitoring", + // "https://www.googleapis.com/auth/monitoring.read" + // ] + // } + +} + +// method id "monitoring.projects.snoozes.list": + +type ProjectsSnoozesListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists the Snoozes associated with a project. Can optionally +// pass in filter, which specifies predicates to match Snoozes. +// +// - parent: The project +// (https://cloud.google.com/monitoring/api/v3#project_name) whose +// Snoozes should be listed. The format is: +// projects/[PROJECT_ID_OR_NUMBER]. +func (r *ProjectsSnoozesService) List(parent string) *ProjectsSnoozesListCall { + c := &ProjectsSnoozesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// Filter sets the optional parameter "filter": Optional filter to +// restrict results to the given criteria. The following fields are +// supported. interval.start_time interval.end_timeFor example: ``` +// interval.start_time > "2022-03-11T00:00:00-08:00" AND +// interval.end_time < "2022-03-12T00:00:00-08:00" ``` +func (c *ProjectsSnoozesListCall) Filter(filter string) *ProjectsSnoozesListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of results to return for a single query. The server may further +// constrain the maximum number of results returned in a single page. +// The value should be in the range 1, 1000. If the value given is +// outside this range, the server will decide the number of results to +// be returned. +func (c *ProjectsSnoozesListCall) PageSize(pageSize int64) *ProjectsSnoozesListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": The +// next_page_token from a previous call to ListSnoozesRequest to get the +// next page of results. +func (c *ProjectsSnoozesListCall) PageToken(pageToken string) *ProjectsSnoozesListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsSnoozesListCall) Fields(s ...googleapi.Field) *ProjectsSnoozesListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsSnoozesListCall) IfNoneMatch(entityTag string) *ProjectsSnoozesListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsSnoozesListCall) Context(ctx context.Context) *ProjectsSnoozesListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsSnoozesListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSnoozesListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+parent}/snoozes") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "monitoring.projects.snoozes.list" call. +// Exactly one of *ListSnoozesResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListSnoozesResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsSnoozesListCall) Do(opts ...googleapi.CallOption) (*ListSnoozesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListSnoozesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.", + // "flatPath": "v3/projects/{projectsId}/snoozes", + // "httpMethod": "GET", + // "id": "monitoring.projects.snoozes.list", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "filter": { + // "description": "Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time \u003e \"2022-03-11T00:00:00-08:00\" AND interval.end_time \u003c \"2022-03-12T00:00:00-08:00\" ``` ", + // "location": "query", + // "type": "string" + // }, + // "pageSize": { + // "description": "Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range 1, 1000. If the value given is outside this range, the server will decide the number of results to be returned.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] ", + // "location": "path", + // "pattern": "^projects/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v3/{+parent}/snoozes", + // "response": { + // "$ref": "ListSnoozesResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/monitoring", + // "https://www.googleapis.com/auth/monitoring.read" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsSnoozesListCall) Pages(ctx context.Context, f func(*ListSnoozesResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "monitoring.projects.snoozes.patch": + +type ProjectsSnoozesPatchCall struct { + s *Service + name string + snooze *Snooze + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Patch: Updates a Snooze, identified by its name, with the parameters +// in the given Snooze object. +// +// - name: The name of the Snooze. The format is: +// projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the +// Snooze will be generated by the system. +func (r *ProjectsSnoozesService) Patch(name string, snooze *Snooze) *ProjectsSnoozesPatchCall { + c := &ProjectsSnoozesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.snooze = snooze + return c +} + +// UpdateMask sets the optional parameter "updateMask": Required. The +// fields to update.For each field listed in update_mask: If the Snooze +// object supplied in the UpdateSnoozeRequest has a value for that +// field, the value of the field in the existing Snooze will be set to +// the value of the field in the supplied Snooze. If the field does not +// have a value in the supplied Snooze, the field in the existing Snooze +// is set to its default value.Fields not listed retain their existing +// value.The following are the field names that are accepted in +// update_mask: display_name interval.start_time interval.end_timeThat +// said, the start time and end time of the Snooze determines which +// fields can legally be updated. Before attempting an update, users +// should consult the documentation for UpdateSnoozeRequest, which talks +// about which fields can be updated. +func (c *ProjectsSnoozesPatchCall) UpdateMask(updateMask string) *ProjectsSnoozesPatchCall { + c.urlParams_.Set("updateMask", updateMask) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsSnoozesPatchCall) Fields(s ...googleapi.Field) *ProjectsSnoozesPatchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsSnoozesPatchCall) Context(ctx context.Context) *ProjectsSnoozesPatchCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsSnoozesPatchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSnoozesPatchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.snooze) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("PATCH", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "monitoring.projects.snoozes.patch" call. +// Exactly one of *Snooze or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Snooze.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *ProjectsSnoozesPatchCall) Do(opts ...googleapi.CallOption) (*Snooze, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Snooze{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Updates a Snooze, identified by its name, with the parameters in the given Snooze object.", + // "flatPath": "v3/projects/{projectsId}/snoozes/{snoozesId}", + // "httpMethod": "PATCH", + // "id": "monitoring.projects.snoozes.patch", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.", + // "location": "path", + // "pattern": "^projects/[^/]+/snoozes/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "updateMask": { + // "description": "Required. The fields to update.For each field listed in update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze. If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.Fields not listed retain their existing value.The following are the field names that are accepted in update_mask: display_name interval.start_time interval.end_timeThat said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.", + // "format": "google-fieldmask", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v3/{+name}", + // "request": { + // "$ref": "Snooze" + // }, + // "response": { + // "$ref": "Snooze" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/monitoring" + // ] + // } + +} + // method id "monitoring.projects.timeSeries.create": type ProjectsTimeSeriesCreateCall struct { diff --git a/recaptchaenterprise/v1/recaptchaenterprise-api.json b/recaptchaenterprise/v1/recaptchaenterprise-api.json index 2d16a12609b..1cc19c5f96d 100644 --- a/recaptchaenterprise/v1/recaptchaenterprise-api.json +++ b/recaptchaenterprise/v1/recaptchaenterprise-api.json @@ -12,7 +12,7 @@ "baseUrl": "https://recaptchaenterprise.googleapis.com/", "batchPath": "batch", "canonicalName": "Recaptcha Enterprise", - "description": "", + "description": "Help protect your website from fraudulent activity, spam, and abuse without creating friction.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recaptcha-enterprise/", "fullyEncodeReservedExpansion": true, @@ -514,7 +514,7 @@ } } }, - "revision": "20221106", + "revision": "20221204", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -545,6 +545,57 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo": { + "description": "Information about account verification, used for identity verification.", + "id": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo", + "properties": { + "endpoints": { + "description": "Endpoints that can be used for identity verification.", + "items": { + "$ref": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo" + }, + "type": "array" + }, + "languageCode": { + "description": "Language code preference for the verification message, set as a IETF BCP 47 language code.", + "type": "string" + }, + "latestVerificationResult": { + "description": "Output only. Result of the latest account verification challenge.", + "enum": [ + "RESULT_UNSPECIFIED", + "SUCCESS_USER_VERIFIED", + "ERROR_USER_NOT_VERIFIED", + "ERROR_SITE_ONBOARDING_INCOMPLETE", + "ERROR_RECIPIENT_NOT_ALLOWED", + "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED", + "ERROR_CRITICAL_INTERNAL", + "ERROR_CUSTOMER_QUOTA_EXHAUSTED", + "ERROR_VERIFICATION_BYPASSED", + "ERROR_VERDICT_MISMATCH" + ], + "enumDescriptions": [ + "No information about the latest account verification.", + "The user was successfully verified. This means the account verification challenge was successfully completed.", + "The user failed the verification challenge.", + "The site is not properly onboarded to use the account verification feature.", + "The recipient is not allowed for account verification. This can occur during integration but should not occur in production.", + "The recipient has already been sent too many verification codes in a short amount of time.", + "The verification flow could not be completed due to a critical internal error.", + "The client has exceeded their two factor request quota for this period of time.", + "The request cannot be processed at the time because of an incident. This bypass can be restricted to a problematic destination email domain, a customer, or could affect the entire service.", + "The request parameters do not match with the token provided and cannot be processed." + ], + "readOnly": true, + "type": "string" + }, + "username": { + "description": "Username of the account that is being verified. Deprecated. Customers should now provide the hashed account ID field in Event.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings": { "description": "Settings specific to keys that can be used by Android apps.", "id": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings", @@ -648,6 +699,10 @@ "$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment", "description": "Assessment returned by account defender when a hashed_account_id is provided." }, + "accountVerification": { + "$ref": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo", + "description": "Account verification information for identity verification. The assessment event must include a token and site key to use this feature." + }, "event": { "$ref": "GoogleCloudRecaptchaenterpriseV1Event", "description": "The event being assessed." @@ -701,6 +756,32 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo": { + "description": "Information about a verification endpoint that can be used for 2FA.", + "id": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo", + "properties": { + "emailAddress": { + "description": "Email address for which to trigger a verification request.", + "type": "string" + }, + "lastVerificationTime": { + "description": "Output only. Timestamp of the last successful verification for the endpoint, if any.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "phoneNumber": { + "description": "Phone number for which to trigger a verification request. Should be given in E.164 format.", + "type": "string" + }, + "requestToken": { + "description": "Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1Event": { "id": "GoogleCloudRecaptchaenterpriseV1Event", "properties": { @@ -885,7 +966,12 @@ "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest": { "description": "The migrate key request message.", "id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest", - "properties": {}, + "properties": { + "skipBillingCheck": { + "description": "Optional. Whether or not to do billing check. A reCAPTCHA Enterprise or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification": { diff --git a/recaptchaenterprise/v1/recaptchaenterprise-gen.go b/recaptchaenterprise/v1/recaptchaenterprise-gen.go index 6f41dd3b4f9..93e42dd94b2 100644 --- a/recaptchaenterprise/v1/recaptchaenterprise-gen.go +++ b/recaptchaenterprise/v1/recaptchaenterprise-gen.go @@ -249,6 +249,72 @@ func (s *GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment) MarshalJSON( return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: Information +// about account verification, used for identity verification. +type GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo struct { + // Endpoints: Endpoints that can be used for identity verification. + Endpoints []*GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo `json:"endpoints,omitempty"` + + // LanguageCode: Language code preference for the verification message, + // set as a IETF BCP 47 language code. + LanguageCode string `json:"languageCode,omitempty"` + + // LatestVerificationResult: Output only. Result of the latest account + // verification challenge. + // + // Possible values: + // "RESULT_UNSPECIFIED" - No information about the latest account + // verification. + // "SUCCESS_USER_VERIFIED" - The user was successfully verified. This + // means the account verification challenge was successfully completed. + // "ERROR_USER_NOT_VERIFIED" - The user failed the verification + // challenge. + // "ERROR_SITE_ONBOARDING_INCOMPLETE" - The site is not properly + // onboarded to use the account verification feature. + // "ERROR_RECIPIENT_NOT_ALLOWED" - The recipient is not allowed for + // account verification. This can occur during integration but should + // not occur in production. + // "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED" - The recipient has already + // been sent too many verification codes in a short amount of time. + // "ERROR_CRITICAL_INTERNAL" - The verification flow could not be + // completed due to a critical internal error. + // "ERROR_CUSTOMER_QUOTA_EXHAUSTED" - The client has exceeded their + // two factor request quota for this period of time. + // "ERROR_VERIFICATION_BYPASSED" - The request cannot be processed at + // the time because of an incident. This bypass can be restricted to a + // problematic destination email domain, a customer, or could affect the + // entire service. + // "ERROR_VERDICT_MISMATCH" - The request parameters do not match with + // the token provided and cannot be processed. + LatestVerificationResult string `json:"latestVerificationResult,omitempty"` + + // Username: Username of the account that is being verified. Deprecated. + // Customers should now provide the hashed account ID field in Event. + Username string `json:"username,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Endpoints") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Endpoints") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: Settings specific // to keys that can be used by Android apps. type GoogleCloudRecaptchaenterpriseV1AndroidKeySettings struct { @@ -401,6 +467,11 @@ type GoogleCloudRecaptchaenterpriseV1Assessment struct { // when a hashed_account_id is provided. AccountDefenderAssessment *GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment `json:"accountDefenderAssessment,omitempty"` + // AccountVerification: Account verification information for identity + // verification. The assessment event must include a token and site key + // to use this feature. + AccountVerification *GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo `json:"accountVerification,omitempty"` + // Event: The event being assessed. Event *GoogleCloudRecaptchaenterpriseV1Event `json:"event,omitempty"` @@ -494,6 +565,48 @@ func (s *GoogleCloudRecaptchaenterpriseV1ChallengeMetrics) MarshalJSON() ([]byte return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: Information +// about a verification endpoint that can be used for 2FA. +type GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo struct { + // EmailAddress: Email address for which to trigger a verification + // request. + EmailAddress string `json:"emailAddress,omitempty"` + + // LastVerificationTime: Output only. Timestamp of the last successful + // verification for the endpoint, if any. + LastVerificationTime string `json:"lastVerificationTime,omitempty"` + + // PhoneNumber: Phone number for which to trigger a verification + // request. Should be given in E.164 format. + PhoneNumber string `json:"phoneNumber,omitempty"` + + // RequestToken: Output only. Token to provide to the client to trigger + // endpoint verification. It must be used within 15 minutes. + RequestToken string `json:"requestToken,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EmailAddress") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EmailAddress") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + type GoogleCloudRecaptchaenterpriseV1Event struct { // ExpectedAction: Optional. The expected action for this type of event. // This should be the same action provided at token generation time on @@ -805,6 +918,39 @@ func (s *GoogleCloudRecaptchaenterpriseV1Metrics) MarshalJSON() ([]byte, error) // GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: The migrate key // request message. type GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest struct { + // SkipBillingCheck: Optional. Whether or not to do billing check. A + // reCAPTCHA Enterprise or migrated key behaves differently than a + // reCAPTCHA (non-Enterprise version) key when you reach a quota limit + // (see + // https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To + // avoid any disruption of your usage, we check that a billing account + // is present. If your usage of reCAPTCHA is under the free quota, you + // can safely skip the billing check and proceed with the migration. See + // https://cloud.google.com/recaptcha-enterprise/docs/billing-information. + SkipBillingCheck bool `json:"skipBillingCheck,omitempty"` + + // ForceSendFields is a list of field names (e.g. "SkipBillingCheck") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SkipBillingCheck") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } // GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: diff --git a/securitycenter/v1/securitycenter-api.json b/securitycenter/v1/securitycenter-api.json index e0007d613c8..c9199742f5c 100644 --- a/securitycenter/v1/securitycenter-api.json +++ b/securitycenter/v1/securitycenter-api.json @@ -246,7 +246,7 @@ "bigQueryExports": { "methods": { "create": { - "description": "Creates a big query export.", + "description": "Creates a BigQuery export.", "flatPath": "v1/folders/{foldersId}/bigQueryExports", "httpMethod": "POST", "id": "securitycenter.folders.bigQueryExports.create", @@ -260,7 +260,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new BigQuery export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -279,7 +279,7 @@ ] }, "delete": { - "description": "Deletes an existing big query export.", + "description": "Deletes an existing BigQuery export.", "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "DELETE", "id": "securitycenter.folders.bigQueryExports.delete", @@ -288,7 +288,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -304,7 +304,7 @@ ] }, "get": { - "description": "Gets a big query export.", + "description": "Gets a BigQuery export.", "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "GET", "id": "securitycenter.folders.bigQueryExports.get", @@ -313,7 +313,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -601,7 +601,7 @@ ], "parameters": { "configId": { - "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.", + "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contain alphanumeric characters, underscores or hyphens only.", "location": "query", "type": "string" }, @@ -924,7 +924,7 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -952,7 +952,6 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1024,7 +1023,7 @@ ], "parameters": { "name": { - "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", "required": true, @@ -1286,7 +1285,7 @@ "bigQueryExports": { "methods": { "create": { - "description": "Creates a big query export.", + "description": "Creates a BigQuery export.", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports", "httpMethod": "POST", "id": "securitycenter.organizations.bigQueryExports.create", @@ -1300,7 +1299,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new BigQuery export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1319,7 +1318,7 @@ ] }, "delete": { - "description": "Deletes an existing big query export.", + "description": "Deletes an existing BigQuery export.", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.bigQueryExports.delete", @@ -1328,7 +1327,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -1344,7 +1343,7 @@ ] }, "get": { - "description": "Gets a big query export.", + "description": "Gets a BigQuery export.", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "GET", "id": "securitycenter.organizations.bigQueryExports.get", @@ -1353,7 +1352,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -1641,7 +1640,7 @@ ], "parameters": { "configId": { - "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.", + "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contain alphanumeric characters, underscores or hyphens only.", "location": "query", "type": "string" }, @@ -2288,7 +2287,7 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -2316,7 +2315,6 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -2388,7 +2386,7 @@ ], "parameters": { "name": { - "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", "required": true, @@ -2561,7 +2559,7 @@ "bigQueryExports": { "methods": { "create": { - "description": "Creates a big query export.", + "description": "Creates a BigQuery export.", "flatPath": "v1/projects/{projectsId}/bigQueryExports", "httpMethod": "POST", "id": "securitycenter.projects.bigQueryExports.create", @@ -2575,7 +2573,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new BigQuery export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2594,7 +2592,7 @@ ] }, "delete": { - "description": "Deletes an existing big query export.", + "description": "Deletes an existing BigQuery export.", "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "DELETE", "id": "securitycenter.projects.bigQueryExports.delete", @@ -2603,7 +2601,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2619,7 +2617,7 @@ ] }, "get": { - "description": "Gets a big query export.", + "description": "Gets a BigQuery export.", "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "GET", "id": "securitycenter.projects.bigQueryExports.get", @@ -2628,7 +2626,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2916,7 +2914,7 @@ ], "parameters": { "configId": { - "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.", + "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contain alphanumeric characters, underscores or hyphens only.", "location": "query", "type": "string" }, @@ -3239,7 +3237,7 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -3267,7 +3265,6 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -3339,7 +3336,7 @@ ], "parameters": { "name": { - "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", "required": true, @@ -3372,7 +3369,7 @@ } } }, - "revision": "20221121", + "revision": "20221205", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -4329,7 +4326,7 @@ }, "vulnerability": { "$ref": "Vulnerability", - "description": "Represents vulnerability specific fields like cve, cvss scores etc. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" + "description": "Represents vulnerability-specific fields like CVE and CVS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" } }, "type": "object" @@ -4556,7 +4553,7 @@ "type": "string" }, "name": { - "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "type": "string" }, "status": { @@ -5199,27 +5196,27 @@ "type": "string" }, "unexpectedCodeModification": { - "description": "Flag indicating unexpected modifications of kernel code memory.", + "description": "True when unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { - "description": "Flag indicating presence of ftrace points with callbacks pointing to regions that are not in the expected kernel or module code range.", + "description": "True when `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { - "description": "Flag indicating presence of interrupt handlers that are are not in the expected kernel, module code regions.", + "description": "True when interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { - "description": "Flag indicating presence of kernel code pages that are not in the expected kernel, module code regions.", + "description": "True when kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { - "description": "Flag indicating presence of kprobe points with callbacks pointing to regions that are not in the expected kernel or module code range.", + "description": "True when `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { - "description": "Flag indicating unexpected process(es) in the scheduler run-queue, those that are in the run-queue, but not in the process task-list.", + "description": "True when unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { @@ -5227,7 +5224,7 @@ "type": "boolean" }, "unexpectedSystemCallHandler": { - "description": "Flag indicating presence of system call handlers that are are not in the expected kernel, module code regions.", + "description": "True when system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, @@ -6227,7 +6224,7 @@ "type": "object" }, "SetFindingStateRequest": { - "description": "Request message for updating a finding's state.", + "description": "Request message for updating a finding's state. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "id": "SetFindingStateRequest", "properties": { "startTime": { diff --git a/securitycenter/v1/securitycenter-gen.go b/securitycenter/v1/securitycenter-gen.go index 429cbab9b3e..bbcf25c3556 100644 --- a/securitycenter/v1/securitycenter-gen.go +++ b/securitycenter/v1/securitycenter-gen.go @@ -1956,8 +1956,8 @@ type Finding struct { // otherwise addressed and is no longer active. State string `json:"state,omitempty"` - // Vulnerability: Represents vulnerability specific fields like cve, - // cvss scores etc. CVE stands for Common Vulnerabilities and Exposures + // Vulnerability: Represents vulnerability-specific fields like CVE and + // CVS scores. CVE stands for Common Vulnerabilities and Exposures // (https://cve.mitre.org/about/) Vulnerability *Vulnerability `json:"vulnerability,omitempty"` @@ -2354,10 +2354,10 @@ type GoogleCloudSecuritycenterV1ExternalSystem struct { // external system. ExternalUid string `json:"externalUid,omitempty"` - // Name: External System Name e.g. jira, demisto, etc. e.g.: - // `organizations/1234/sources/5678/findings/123456/externalSystems/jira` - // `folders/1234/sources/5678/findings/123456/externalSystems/jira` - // `projects/1234/sources/5678/findings/123456/externalSystems/jira` + // Name: Full resource name of the external system, for example: + // "organizations/1234/sources/5678/findings/123456/externalSystems/jira" + // , "folders/1234/sources/5678/findings/123456/externalSystems/jira", + // "projects/1234/sources/5678/findings/123456/externalSystems/jira" Name string `json:"name,omitempty"` // Status: Most recent status of the corresponding finding's @@ -3494,41 +3494,39 @@ type KernelRootkit struct { // Name: Rootkit name when available. Name string `json:"name,omitempty"` - // UnexpectedCodeModification: Flag indicating unexpected modifications - // of kernel code memory. + // UnexpectedCodeModification: True when unexpected modifications of + // kernel read-only data memory are present. UnexpectedCodeModification bool `json:"unexpectedCodeModification,omitempty"` - // UnexpectedFtraceHandler: Flag indicating presence of ftrace points - // with callbacks pointing to regions that are not in the expected - // kernel or module code range. + // UnexpectedFtraceHandler: True when `ftrace` points are present with + // callbacks pointing to regions that are not in the expected kernel or + // module code range. UnexpectedFtraceHandler bool `json:"unexpectedFtraceHandler,omitempty"` - // UnexpectedInterruptHandler: Flag indicating presence of interrupt - // handlers that are are not in the expected kernel, module code - // regions. + // UnexpectedInterruptHandler: True when interrupt handlers that are are + // not in the expected kernel or module code regions are present. UnexpectedInterruptHandler bool `json:"unexpectedInterruptHandler,omitempty"` - // UnexpectedKernelCodePages: Flag indicating presence of kernel code - // pages that are not in the expected kernel, module code regions. + // UnexpectedKernelCodePages: True when kernel code pages that are not + // in the expected kernel or module code regions are present. UnexpectedKernelCodePages bool `json:"unexpectedKernelCodePages,omitempty"` - // UnexpectedKprobeHandler: Flag indicating presence of kprobe points - // with callbacks pointing to regions that are not in the expected - // kernel or module code range. + // UnexpectedKprobeHandler: True when `kprobe` points are present with + // callbacks pointing to regions that are not in the expected kernel or + // module code range. UnexpectedKprobeHandler bool `json:"unexpectedKprobeHandler,omitempty"` - // UnexpectedProcessesInRunqueue: Flag indicating unexpected process(es) - // in the scheduler run-queue, those that are in the run-queue, but not - // in the process task-list. + // UnexpectedProcessesInRunqueue: True when unexpected processes in the + // scheduler run queue are present. Such processes are in the run queue, + // but not in the process task list. UnexpectedProcessesInRunqueue bool `json:"unexpectedProcessesInRunqueue,omitempty"` // UnexpectedReadOnlyDataModification: Flag indicating unexpected // modifications of kernel read-only data memory. UnexpectedReadOnlyDataModification bool `json:"unexpectedReadOnlyDataModification,omitempty"` - // UnexpectedSystemCallHandler: Flag indicating presence of system call - // handlers that are are not in the expected kernel, module code - // regions. + // UnexpectedSystemCallHandler: True when system call handlers that are + // are not in the expected kernel or module code regions are present. UnexpectedSystemCallHandler bool `json:"unexpectedSystemCallHandler,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to @@ -4996,7 +4994,13 @@ func (s *ServiceAccountDelegationInfo) MarshalJSON() ([]byte, error) { } // SetFindingStateRequest: Request message for updating a finding's -// state. +// state. The relative resource name +// (https://cloud.google.com/apis/design/resource_names#relative_resource_name) +// of the finding. Example: +// "organizations/{organization_id}/sources/{source_id}/findings/{finding +// _id}", +// "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", +// "projects/{project_id}/sources/{source_id}/findings/{finding_id}". type SetFindingStateRequest struct { // StartTime: Required. The time at which the updated state takes // effect. @@ -6099,9 +6103,9 @@ type FoldersBigQueryExportsCreateCall struct { header_ http.Header } -// Create: Creates a big query export. +// Create: Creates a BigQuery export. // -// - parent: Resource name of the new big query export's parent. Its +// - parent: Resource name of the new BigQuery export's parent. Its // format is "organizations/[organization_id]", "folders/[folder_id]", // or "projects/[project_id]". func (r *FoldersBigQueryExportsService) Create(parent string, googlecloudsecuritycenterv1bigqueryexport *GoogleCloudSecuritycenterV1BigQueryExport) *FoldersBigQueryExportsCreateCall { @@ -6214,7 +6218,7 @@ func (c *FoldersBigQueryExportsCreateCall) Do(opts ...googleapi.CallOption) (*Go } return ret, nil // { - // "description": "Creates a big query export.", + // "description": "Creates a BigQuery export.", // "flatPath": "v1/folders/{foldersId}/bigQueryExports", // "httpMethod": "POST", // "id": "securitycenter.folders.bigQueryExports.create", @@ -6228,7 +6232,7 @@ func (c *FoldersBigQueryExportsCreateCall) Do(opts ...googleapi.CallOption) (*Go // "type": "string" // }, // "parent": { - // "description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + // "description": "Required. Resource name of the new BigQuery export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", // "location": "path", // "pattern": "^folders/[^/]+$", // "required": true, @@ -6259,9 +6263,9 @@ type FoldersBigQueryExportsDeleteCall struct { header_ http.Header } -// Delete: Deletes an existing big query export. +// Delete: Deletes an existing BigQuery export. // -// - name: Name of the big query export to delete. Its format is +// - name: Name of the BigQuery export to delete. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id}. @@ -6357,7 +6361,7 @@ func (c *FoldersBigQueryExportsDeleteCall) Do(opts ...googleapi.CallOption) (*Em } return ret, nil // { - // "description": "Deletes an existing big query export.", + // "description": "Deletes an existing BigQuery export.", // "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", // "httpMethod": "DELETE", // "id": "securitycenter.folders.bigQueryExports.delete", @@ -6366,7 +6370,7 @@ func (c *FoldersBigQueryExportsDeleteCall) Do(opts ...googleapi.CallOption) (*Em // ], // "parameters": { // "name": { - // "description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + // "description": "Required. Name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", // "location": "path", // "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", // "required": true, @@ -6395,9 +6399,9 @@ type FoldersBigQueryExportsGetCall struct { header_ http.Header } -// Get: Gets a big query export. +// Get: Gets a BigQuery export. // -// - name: Name of the big query export to retrieve. Its format is +// - name: Name of the BigQuery export to retrieve. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id}. @@ -6508,7 +6512,7 @@ func (c *FoldersBigQueryExportsGetCall) Do(opts ...googleapi.CallOption) (*Googl } return ret, nil // { - // "description": "Gets a big query export.", + // "description": "Gets a BigQuery export.", // "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", // "httpMethod": "GET", // "id": "securitycenter.folders.bigQueryExports.get", @@ -6517,7 +6521,7 @@ func (c *FoldersBigQueryExportsGetCall) Do(opts ...googleapi.CallOption) (*Googl // ], // "parameters": { // "name": { - // "description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + // "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", // "location": "path", // "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", // "required": true, @@ -7877,7 +7881,7 @@ func (r *FoldersNotificationConfigsService) Create(parent string, notificationco // ConfigId sets the optional parameter "configId": Required. Unique // identifier provided by the client within the parent scope. It must be -// between 1 and 128 characters, and contains alphanumeric characters, +// between 1 and 128 characters, and contain alphanumeric characters, // underscores or hyphens only. func (c *FoldersNotificationConfigsCreateCall) ConfigId(configId string) *FoldersNotificationConfigsCreateCall { c.urlParams_.Set("configId", configId) @@ -7984,7 +7988,7 @@ func (c *FoldersNotificationConfigsCreateCall) Do(opts ...googleapi.CallOption) // ], // "parameters": { // "configId": { - // "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.", + // "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contain alphanumeric characters, underscores or hyphens only.", // "location": "query", // "type": "string" // }, @@ -9530,9 +9534,9 @@ type FoldersSourcesFindingsSetMuteCall struct { // SetMute: Updates the mute state of a finding. // -// - name: The relative resource name of the finding. See: -// https://cloud.google.com/apis/design/resource_names#relative_resource_name -// Example: +// - name: The relative resource name +// (https://cloud.google.com/apis/design/resource_names#relative_resource_name) +// of the finding. Example: // "organizations/{organization_id}/sources/{source_id}/findings/{findi // ng_id}", // "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", @@ -9644,7 +9648,7 @@ func (c *FoldersSourcesFindingsSetMuteCall) Do(opts ...googleapi.CallOption) (*F // ], // "parameters": { // "name": { - // "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + // "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", // "location": "path", // "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", // "required": true, @@ -9678,11 +9682,7 @@ type FoldersSourcesFindingsSetStateCall struct { // SetState: Updates the state of a finding. // -// - name: The relative resource name of the finding. See: -// https://cloud.google.com/apis/design/resource_names#relative_resource_name -// Example: -// "organizations/{organization_id}/sources/{source_id}/findings/{findi -// ng_id}". +// - name: . func (r *FoldersSourcesFindingsService) SetState(name string, setfindingstaterequest *SetFindingStateRequest) *FoldersSourcesFindingsSetStateCall { c := &FoldersSourcesFindingsSetStateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -9790,7 +9790,6 @@ func (c *FoldersSourcesFindingsSetStateCall) Do(opts ...googleapi.CallOption) (* // ], // "parameters": { // "name": { - // "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".", // "location": "path", // "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", // "required": true, @@ -10002,10 +10001,11 @@ type FoldersSourcesFindingsExternalSystemsPatchCall struct { // Patch: Updates external system. This is for a given finding. // -// - name: External System Name e.g. jira, demisto, etc. e.g.: -// `organizations/1234/sources/5678/findings/123456/externalSystems/jir -// a` `folders/1234/sources/5678/findings/123456/externalSystems/jira` -// `projects/1234/sources/5678/findings/123456/externalSystems/jira`. +// - name: Full resource name of the external system, for example: +// "organizations/1234/sources/5678/findings/123456/externalSystems/jir +// a", +// "folders/1234/sources/5678/findings/123456/externalSystems/jira", +// "projects/1234/sources/5678/findings/123456/externalSystems/jira". func (r *FoldersSourcesFindingsExternalSystemsService) Patch(name string, googlecloudsecuritycenterv1externalsystem *GoogleCloudSecuritycenterV1ExternalSystem) *FoldersSourcesFindingsExternalSystemsPatchCall { c := &FoldersSourcesFindingsExternalSystemsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -10123,7 +10123,7 @@ func (c *FoldersSourcesFindingsExternalSystemsPatchCall) Do(opts ...googleapi.Ca // ], // "parameters": { // "name": { - // "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + // "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", // "location": "path", // "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", // "required": true, @@ -11288,9 +11288,9 @@ type OrganizationsBigQueryExportsCreateCall struct { header_ http.Header } -// Create: Creates a big query export. +// Create: Creates a BigQuery export. // -// - parent: Resource name of the new big query export's parent. Its +// - parent: Resource name of the new BigQuery export's parent. Its // format is "organizations/[organization_id]", "folders/[folder_id]", // or "projects/[project_id]". func (r *OrganizationsBigQueryExportsService) Create(parent string, googlecloudsecuritycenterv1bigqueryexport *GoogleCloudSecuritycenterV1BigQueryExport) *OrganizationsBigQueryExportsCreateCall { @@ -11403,7 +11403,7 @@ func (c *OrganizationsBigQueryExportsCreateCall) Do(opts ...googleapi.CallOption } return ret, nil // { - // "description": "Creates a big query export.", + // "description": "Creates a BigQuery export.", // "flatPath": "v1/organizations/{organizationsId}/bigQueryExports", // "httpMethod": "POST", // "id": "securitycenter.organizations.bigQueryExports.create", @@ -11417,7 +11417,7 @@ func (c *OrganizationsBigQueryExportsCreateCall) Do(opts ...googleapi.CallOption // "type": "string" // }, // "parent": { - // "description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + // "description": "Required. Resource name of the new BigQuery export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", // "location": "path", // "pattern": "^organizations/[^/]+$", // "required": true, @@ -11448,9 +11448,9 @@ type OrganizationsBigQueryExportsDeleteCall struct { header_ http.Header } -// Delete: Deletes an existing big query export. +// Delete: Deletes an existing BigQuery export. // -// - name: Name of the big query export to delete. Its format is +// - name: Name of the BigQuery export to delete. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id}. @@ -11546,7 +11546,7 @@ func (c *OrganizationsBigQueryExportsDeleteCall) Do(opts ...googleapi.CallOption } return ret, nil // { - // "description": "Deletes an existing big query export.", + // "description": "Deletes an existing BigQuery export.", // "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", // "httpMethod": "DELETE", // "id": "securitycenter.organizations.bigQueryExports.delete", @@ -11555,7 +11555,7 @@ func (c *OrganizationsBigQueryExportsDeleteCall) Do(opts ...googleapi.CallOption // ], // "parameters": { // "name": { - // "description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + // "description": "Required. Name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", // "location": "path", // "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", // "required": true, @@ -11584,9 +11584,9 @@ type OrganizationsBigQueryExportsGetCall struct { header_ http.Header } -// Get: Gets a big query export. +// Get: Gets a BigQuery export. // -// - name: Name of the big query export to retrieve. Its format is +// - name: Name of the BigQuery export to retrieve. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id}. @@ -11697,7 +11697,7 @@ func (c *OrganizationsBigQueryExportsGetCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Gets a big query export.", + // "description": "Gets a BigQuery export.", // "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", // "httpMethod": "GET", // "id": "securitycenter.organizations.bigQueryExports.get", @@ -11706,7 +11706,7 @@ func (c *OrganizationsBigQueryExportsGetCall) Do(opts ...googleapi.CallOption) ( // ], // "parameters": { // "name": { - // "description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + // "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", // "location": "path", // "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", // "required": true, @@ -13066,7 +13066,7 @@ func (r *OrganizationsNotificationConfigsService) Create(parent string, notifica // ConfigId sets the optional parameter "configId": Required. Unique // identifier provided by the client within the parent scope. It must be -// between 1 and 128 characters, and contains alphanumeric characters, +// between 1 and 128 characters, and contain alphanumeric characters, // underscores or hyphens only. func (c *OrganizationsNotificationConfigsCreateCall) ConfigId(configId string) *OrganizationsNotificationConfigsCreateCall { c.urlParams_.Set("configId", configId) @@ -13173,7 +13173,7 @@ func (c *OrganizationsNotificationConfigsCreateCall) Do(opts ...googleapi.CallOp // ], // "parameters": { // "configId": { - // "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.", + // "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contain alphanumeric characters, underscores or hyphens only.", // "location": "query", // "type": "string" // }, @@ -16398,9 +16398,9 @@ type OrganizationsSourcesFindingsSetMuteCall struct { // SetMute: Updates the mute state of a finding. // -// - name: The relative resource name of the finding. See: -// https://cloud.google.com/apis/design/resource_names#relative_resource_name -// Example: +// - name: The relative resource name +// (https://cloud.google.com/apis/design/resource_names#relative_resource_name) +// of the finding. Example: // "organizations/{organization_id}/sources/{source_id}/findings/{findi // ng_id}", // "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", @@ -16512,7 +16512,7 @@ func (c *OrganizationsSourcesFindingsSetMuteCall) Do(opts ...googleapi.CallOptio // ], // "parameters": { // "name": { - // "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + // "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", // "location": "path", // "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", // "required": true, @@ -16546,11 +16546,7 @@ type OrganizationsSourcesFindingsSetStateCall struct { // SetState: Updates the state of a finding. // -// - name: The relative resource name of the finding. See: -// https://cloud.google.com/apis/design/resource_names#relative_resource_name -// Example: -// "organizations/{organization_id}/sources/{source_id}/findings/{findi -// ng_id}". +// - name: . func (r *OrganizationsSourcesFindingsService) SetState(name string, setfindingstaterequest *SetFindingStateRequest) *OrganizationsSourcesFindingsSetStateCall { c := &OrganizationsSourcesFindingsSetStateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -16658,7 +16654,6 @@ func (c *OrganizationsSourcesFindingsSetStateCall) Do(opts ...googleapi.CallOpti // ], // "parameters": { // "name": { - // "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".", // "location": "path", // "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", // "required": true, @@ -16870,10 +16865,11 @@ type OrganizationsSourcesFindingsExternalSystemsPatchCall struct { // Patch: Updates external system. This is for a given finding. // -// - name: External System Name e.g. jira, demisto, etc. e.g.: -// `organizations/1234/sources/5678/findings/123456/externalSystems/jir -// a` `folders/1234/sources/5678/findings/123456/externalSystems/jira` -// `projects/1234/sources/5678/findings/123456/externalSystems/jira`. +// - name: Full resource name of the external system, for example: +// "organizations/1234/sources/5678/findings/123456/externalSystems/jir +// a", +// "folders/1234/sources/5678/findings/123456/externalSystems/jira", +// "projects/1234/sources/5678/findings/123456/externalSystems/jira". func (r *OrganizationsSourcesFindingsExternalSystemsService) Patch(name string, googlecloudsecuritycenterv1externalsystem *GoogleCloudSecuritycenterV1ExternalSystem) *OrganizationsSourcesFindingsExternalSystemsPatchCall { c := &OrganizationsSourcesFindingsExternalSystemsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -16991,7 +16987,7 @@ func (c *OrganizationsSourcesFindingsExternalSystemsPatchCall) Do(opts ...google // ], // "parameters": { // "name": { - // "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + // "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", // "location": "path", // "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", // "required": true, @@ -17704,9 +17700,9 @@ type ProjectsBigQueryExportsCreateCall struct { header_ http.Header } -// Create: Creates a big query export. +// Create: Creates a BigQuery export. // -// - parent: Resource name of the new big query export's parent. Its +// - parent: Resource name of the new BigQuery export's parent. Its // format is "organizations/[organization_id]", "folders/[folder_id]", // or "projects/[project_id]". func (r *ProjectsBigQueryExportsService) Create(parent string, googlecloudsecuritycenterv1bigqueryexport *GoogleCloudSecuritycenterV1BigQueryExport) *ProjectsBigQueryExportsCreateCall { @@ -17819,7 +17815,7 @@ func (c *ProjectsBigQueryExportsCreateCall) Do(opts ...googleapi.CallOption) (*G } return ret, nil // { - // "description": "Creates a big query export.", + // "description": "Creates a BigQuery export.", // "flatPath": "v1/projects/{projectsId}/bigQueryExports", // "httpMethod": "POST", // "id": "securitycenter.projects.bigQueryExports.create", @@ -17833,7 +17829,7 @@ func (c *ProjectsBigQueryExportsCreateCall) Do(opts ...googleapi.CallOption) (*G // "type": "string" // }, // "parent": { - // "description": "Required. Resource name of the new big query export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + // "description": "Required. Resource name of the new BigQuery export's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", // "location": "path", // "pattern": "^projects/[^/]+$", // "required": true, @@ -17864,9 +17860,9 @@ type ProjectsBigQueryExportsDeleteCall struct { header_ http.Header } -// Delete: Deletes an existing big query export. +// Delete: Deletes an existing BigQuery export. // -// - name: Name of the big query export to delete. Its format is +// - name: Name of the BigQuery export to delete. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id}. @@ -17962,7 +17958,7 @@ func (c *ProjectsBigQueryExportsDeleteCall) Do(opts ...googleapi.CallOption) (*E } return ret, nil // { - // "description": "Deletes an existing big query export.", + // "description": "Deletes an existing BigQuery export.", // "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", // "httpMethod": "DELETE", // "id": "securitycenter.projects.bigQueryExports.delete", @@ -17971,7 +17967,7 @@ func (c *ProjectsBigQueryExportsDeleteCall) Do(opts ...googleapi.CallOption) (*E // ], // "parameters": { // "name": { - // "description": "Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + // "description": "Required. Name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", // "location": "path", // "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", // "required": true, @@ -18000,9 +17996,9 @@ type ProjectsBigQueryExportsGetCall struct { header_ http.Header } -// Get: Gets a big query export. +// Get: Gets a BigQuery export. // -// - name: Name of the big query export to retrieve. Its format is +// - name: Name of the BigQuery export to retrieve. Its format is // organizations/{organization}/bigQueryExports/{export_id}, // folders/{folder}/bigQueryExports/{export_id}, or // projects/{project}/bigQueryExports/{export_id}. @@ -18113,7 +18109,7 @@ func (c *ProjectsBigQueryExportsGetCall) Do(opts ...googleapi.CallOption) (*Goog } return ret, nil // { - // "description": "Gets a big query export.", + // "description": "Gets a BigQuery export.", // "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", // "httpMethod": "GET", // "id": "securitycenter.projects.bigQueryExports.get", @@ -18122,7 +18118,7 @@ func (c *ProjectsBigQueryExportsGetCall) Do(opts ...googleapi.CallOption) (*Goog // ], // "parameters": { // "name": { - // "description": "Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + // "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", // "location": "path", // "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", // "required": true, @@ -19482,7 +19478,7 @@ func (r *ProjectsNotificationConfigsService) Create(parent string, notificationc // ConfigId sets the optional parameter "configId": Required. Unique // identifier provided by the client within the parent scope. It must be -// between 1 and 128 characters, and contains alphanumeric characters, +// between 1 and 128 characters, and contain alphanumeric characters, // underscores or hyphens only. func (c *ProjectsNotificationConfigsCreateCall) ConfigId(configId string) *ProjectsNotificationConfigsCreateCall { c.urlParams_.Set("configId", configId) @@ -19589,7 +19585,7 @@ func (c *ProjectsNotificationConfigsCreateCall) Do(opts ...googleapi.CallOption) // ], // "parameters": { // "configId": { - // "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only.", + // "description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contain alphanumeric characters, underscores or hyphens only.", // "location": "query", // "type": "string" // }, @@ -21135,9 +21131,9 @@ type ProjectsSourcesFindingsSetMuteCall struct { // SetMute: Updates the mute state of a finding. // -// - name: The relative resource name of the finding. See: -// https://cloud.google.com/apis/design/resource_names#relative_resource_name -// Example: +// - name: The relative resource name +// (https://cloud.google.com/apis/design/resource_names#relative_resource_name) +// of the finding. Example: // "organizations/{organization_id}/sources/{source_id}/findings/{findi // ng_id}", // "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", @@ -21249,7 +21245,7 @@ func (c *ProjectsSourcesFindingsSetMuteCall) Do(opts ...googleapi.CallOption) (* // ], // "parameters": { // "name": { - // "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + // "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", // "location": "path", // "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", // "required": true, @@ -21283,11 +21279,7 @@ type ProjectsSourcesFindingsSetStateCall struct { // SetState: Updates the state of a finding. // -// - name: The relative resource name of the finding. See: -// https://cloud.google.com/apis/design/resource_names#relative_resource_name -// Example: -// "organizations/{organization_id}/sources/{source_id}/findings/{findi -// ng_id}". +// - name: . func (r *ProjectsSourcesFindingsService) SetState(name string, setfindingstaterequest *SetFindingStateRequest) *ProjectsSourcesFindingsSetStateCall { c := &ProjectsSourcesFindingsSetStateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -21395,7 +21387,6 @@ func (c *ProjectsSourcesFindingsSetStateCall) Do(opts ...googleapi.CallOption) ( // ], // "parameters": { // "name": { - // "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\".", // "location": "path", // "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", // "required": true, @@ -21607,10 +21598,11 @@ type ProjectsSourcesFindingsExternalSystemsPatchCall struct { // Patch: Updates external system. This is for a given finding. // -// - name: External System Name e.g. jira, demisto, etc. e.g.: -// `organizations/1234/sources/5678/findings/123456/externalSystems/jir -// a` `folders/1234/sources/5678/findings/123456/externalSystems/jira` -// `projects/1234/sources/5678/findings/123456/externalSystems/jira`. +// - name: Full resource name of the external system, for example: +// "organizations/1234/sources/5678/findings/123456/externalSystems/jir +// a", +// "folders/1234/sources/5678/findings/123456/externalSystems/jira", +// "projects/1234/sources/5678/findings/123456/externalSystems/jira". func (r *ProjectsSourcesFindingsExternalSystemsService) Patch(name string, googlecloudsecuritycenterv1externalsystem *GoogleCloudSecuritycenterV1ExternalSystem) *ProjectsSourcesFindingsExternalSystemsPatchCall { c := &ProjectsSourcesFindingsExternalSystemsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -21728,7 +21720,7 @@ func (c *ProjectsSourcesFindingsExternalSystemsPatchCall) Do(opts ...googleapi.C // ], // "parameters": { // "name": { - // "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + // "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", // "location": "path", // "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", // "required": true, diff --git a/securitycenter/v1beta1/securitycenter-api.json b/securitycenter/v1beta1/securitycenter-api.json index 26c19d8d91e..0025b15dadb 100644 --- a/securitycenter/v1beta1/securitycenter-api.json +++ b/securitycenter/v1beta1/securitycenter-api.json @@ -896,7 +896,7 @@ } } }, - "revision": "20221121", + "revision": "20221205", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1829,7 +1829,7 @@ }, "vulnerability": { "$ref": "Vulnerability", - "description": "Represents vulnerability specific fields like cve, cvss scores etc. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" + "description": "Represents vulnerability-specific fields like CVE and CVS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" } }, "type": "object" @@ -2056,7 +2056,7 @@ "type": "string" }, "name": { - "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "type": "string" }, "status": { @@ -2754,27 +2754,27 @@ "type": "string" }, "unexpectedCodeModification": { - "description": "Flag indicating unexpected modifications of kernel code memory.", + "description": "True when unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { - "description": "Flag indicating presence of ftrace points with callbacks pointing to regions that are not in the expected kernel or module code range.", + "description": "True when `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { - "description": "Flag indicating presence of interrupt handlers that are are not in the expected kernel, module code regions.", + "description": "True when interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { - "description": "Flag indicating presence of kernel code pages that are not in the expected kernel, module code regions.", + "description": "True when kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { - "description": "Flag indicating presence of kprobe points with callbacks pointing to regions that are not in the expected kernel or module code range.", + "description": "True when `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { - "description": "Flag indicating unexpected process(es) in the scheduler run-queue, those that are in the run-queue, but not in the process task-list.", + "description": "True when unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { @@ -2782,7 +2782,7 @@ "type": "boolean" }, "unexpectedSystemCallHandler": { - "description": "Flag indicating presence of system call handlers that are are not in the expected kernel, module code regions.", + "description": "True when system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, diff --git a/securitycenter/v1beta1/securitycenter-gen.go b/securitycenter/v1beta1/securitycenter-gen.go index 108cbf2aaa8..17f1f77ad79 100644 --- a/securitycenter/v1beta1/securitycenter-gen.go +++ b/securitycenter/v1beta1/securitycenter-gen.go @@ -1623,8 +1623,8 @@ type Finding struct { // otherwise addressed and is no longer active. State string `json:"state,omitempty"` - // Vulnerability: Represents vulnerability specific fields like cve, - // cvss scores etc. CVE stands for Common Vulnerabilities and Exposures + // Vulnerability: Represents vulnerability-specific fields like CVE and + // CVS scores. CVE stands for Common Vulnerabilities and Exposures // (https://cve.mitre.org/about/) Vulnerability *Vulnerability `json:"vulnerability,omitempty"` @@ -2013,10 +2013,10 @@ type GoogleCloudSecuritycenterV1ExternalSystem struct { // external system. ExternalUid string `json:"externalUid,omitempty"` - // Name: External System Name e.g. jira, demisto, etc. e.g.: - // `organizations/1234/sources/5678/findings/123456/externalSystems/jira` - // `folders/1234/sources/5678/findings/123456/externalSystems/jira` - // `projects/1234/sources/5678/findings/123456/externalSystems/jira` + // Name: Full resource name of the external system, for example: + // "organizations/1234/sources/5678/findings/123456/externalSystems/jira" + // , "folders/1234/sources/5678/findings/123456/externalSystems/jira", + // "projects/1234/sources/5678/findings/123456/externalSystems/jira" Name string `json:"name,omitempty"` // Status: Most recent status of the corresponding finding's @@ -3185,41 +3185,39 @@ type KernelRootkit struct { // Name: Rootkit name when available. Name string `json:"name,omitempty"` - // UnexpectedCodeModification: Flag indicating unexpected modifications - // of kernel code memory. + // UnexpectedCodeModification: True when unexpected modifications of + // kernel read-only data memory are present. UnexpectedCodeModification bool `json:"unexpectedCodeModification,omitempty"` - // UnexpectedFtraceHandler: Flag indicating presence of ftrace points - // with callbacks pointing to regions that are not in the expected - // kernel or module code range. + // UnexpectedFtraceHandler: True when `ftrace` points are present with + // callbacks pointing to regions that are not in the expected kernel or + // module code range. UnexpectedFtraceHandler bool `json:"unexpectedFtraceHandler,omitempty"` - // UnexpectedInterruptHandler: Flag indicating presence of interrupt - // handlers that are are not in the expected kernel, module code - // regions. + // UnexpectedInterruptHandler: True when interrupt handlers that are are + // not in the expected kernel or module code regions are present. UnexpectedInterruptHandler bool `json:"unexpectedInterruptHandler,omitempty"` - // UnexpectedKernelCodePages: Flag indicating presence of kernel code - // pages that are not in the expected kernel, module code regions. + // UnexpectedKernelCodePages: True when kernel code pages that are not + // in the expected kernel or module code regions are present. UnexpectedKernelCodePages bool `json:"unexpectedKernelCodePages,omitempty"` - // UnexpectedKprobeHandler: Flag indicating presence of kprobe points - // with callbacks pointing to regions that are not in the expected - // kernel or module code range. + // UnexpectedKprobeHandler: True when `kprobe` points are present with + // callbacks pointing to regions that are not in the expected kernel or + // module code range. UnexpectedKprobeHandler bool `json:"unexpectedKprobeHandler,omitempty"` - // UnexpectedProcessesInRunqueue: Flag indicating unexpected process(es) - // in the scheduler run-queue, those that are in the run-queue, but not - // in the process task-list. + // UnexpectedProcessesInRunqueue: True when unexpected processes in the + // scheduler run queue are present. Such processes are in the run queue, + // but not in the process task list. UnexpectedProcessesInRunqueue bool `json:"unexpectedProcessesInRunqueue,omitempty"` // UnexpectedReadOnlyDataModification: Flag indicating unexpected // modifications of kernel read-only data memory. UnexpectedReadOnlyDataModification bool `json:"unexpectedReadOnlyDataModification,omitempty"` - // UnexpectedSystemCallHandler: Flag indicating presence of system call - // handlers that are are not in the expected kernel, module code - // regions. + // UnexpectedSystemCallHandler: True when system call handlers that are + // are not in the expected kernel or module code regions are present. UnexpectedSystemCallHandler bool `json:"unexpectedSystemCallHandler,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to diff --git a/securitycenter/v1beta2/securitycenter-api.json b/securitycenter/v1beta2/securitycenter-api.json index 23832c8b063..fb1f5ce7846 100644 --- a/securitycenter/v1beta2/securitycenter-api.json +++ b/securitycenter/v1beta2/securitycenter-api.json @@ -1981,7 +1981,7 @@ } } }, - "revision": "20221121", + "revision": "20221205", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2896,7 +2896,7 @@ }, "vulnerability": { "$ref": "Vulnerability", - "description": "Represents vulnerability specific fields like cve, cvss scores etc. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" + "description": "Represents vulnerability-specific fields like CVE and CVS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" } }, "type": "object" @@ -3100,7 +3100,7 @@ "type": "string" }, "name": { - "description": "External System Name e.g. jira, demisto, etc. e.g.: `organizations/1234/sources/5678/findings/123456/externalSystems/jira` `folders/1234/sources/5678/findings/123456/externalSystems/jira` `projects/1234/sources/5678/findings/123456/externalSystems/jira`", + "description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "type": "string" }, "status": { @@ -3589,27 +3589,27 @@ "type": "string" }, "unexpectedCodeModification": { - "description": "Flag indicating unexpected modifications of kernel code memory.", + "description": "True when unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { - "description": "Flag indicating presence of ftrace points with callbacks pointing to regions that are not in the expected kernel or module code range.", + "description": "True when `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { - "description": "Flag indicating presence of interrupt handlers that are are not in the expected kernel, module code regions.", + "description": "True when interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { - "description": "Flag indicating presence of kernel code pages that are not in the expected kernel, module code regions.", + "description": "True when kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { - "description": "Flag indicating presence of kprobe points with callbacks pointing to regions that are not in the expected kernel or module code range.", + "description": "True when `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { - "description": "Flag indicating unexpected process(es) in the scheduler run-queue, those that are in the run-queue, but not in the process task-list.", + "description": "True when unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { @@ -3617,7 +3617,7 @@ "type": "boolean" }, "unexpectedSystemCallHandler": { - "description": "Flag indicating presence of system call handlers that are are not in the expected kernel, module code regions.", + "description": "True when system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, diff --git a/securitycenter/v1beta2/securitycenter-gen.go b/securitycenter/v1beta2/securitycenter-gen.go index 09f791005c9..cb6e2dd2922 100644 --- a/securitycenter/v1beta2/securitycenter-gen.go +++ b/securitycenter/v1beta2/securitycenter-gen.go @@ -1706,8 +1706,8 @@ type Finding struct { // otherwise addressed and is no longer active. State string `json:"state,omitempty"` - // Vulnerability: Represents vulnerability specific fields like cve, - // cvss scores etc. CVE stands for Common Vulnerabilities and Exposures + // Vulnerability: Represents vulnerability-specific fields like CVE and + // CVS scores. CVE stands for Common Vulnerabilities and Exposures // (https://cve.mitre.org/about/) Vulnerability *Vulnerability `json:"vulnerability,omitempty"` @@ -2026,10 +2026,10 @@ type GoogleCloudSecuritycenterV1ExternalSystem struct { // external system. ExternalUid string `json:"externalUid,omitempty"` - // Name: External System Name e.g. jira, demisto, etc. e.g.: - // `organizations/1234/sources/5678/findings/123456/externalSystems/jira` - // `folders/1234/sources/5678/findings/123456/externalSystems/jira` - // `projects/1234/sources/5678/findings/123456/externalSystems/jira` + // Name: Full resource name of the external system, for example: + // "organizations/1234/sources/5678/findings/123456/externalSystems/jira" + // , "folders/1234/sources/5678/findings/123456/externalSystems/jira", + // "projects/1234/sources/5678/findings/123456/externalSystems/jira" Name string `json:"name,omitempty"` // Status: Most recent status of the corresponding finding's @@ -2782,41 +2782,39 @@ type KernelRootkit struct { // Name: Rootkit name when available. Name string `json:"name,omitempty"` - // UnexpectedCodeModification: Flag indicating unexpected modifications - // of kernel code memory. + // UnexpectedCodeModification: True when unexpected modifications of + // kernel read-only data memory are present. UnexpectedCodeModification bool `json:"unexpectedCodeModification,omitempty"` - // UnexpectedFtraceHandler: Flag indicating presence of ftrace points - // with callbacks pointing to regions that are not in the expected - // kernel or module code range. + // UnexpectedFtraceHandler: True when `ftrace` points are present with + // callbacks pointing to regions that are not in the expected kernel or + // module code range. UnexpectedFtraceHandler bool `json:"unexpectedFtraceHandler,omitempty"` - // UnexpectedInterruptHandler: Flag indicating presence of interrupt - // handlers that are are not in the expected kernel, module code - // regions. + // UnexpectedInterruptHandler: True when interrupt handlers that are are + // not in the expected kernel or module code regions are present. UnexpectedInterruptHandler bool `json:"unexpectedInterruptHandler,omitempty"` - // UnexpectedKernelCodePages: Flag indicating presence of kernel code - // pages that are not in the expected kernel, module code regions. + // UnexpectedKernelCodePages: True when kernel code pages that are not + // in the expected kernel or module code regions are present. UnexpectedKernelCodePages bool `json:"unexpectedKernelCodePages,omitempty"` - // UnexpectedKprobeHandler: Flag indicating presence of kprobe points - // with callbacks pointing to regions that are not in the expected - // kernel or module code range. + // UnexpectedKprobeHandler: True when `kprobe` points are present with + // callbacks pointing to regions that are not in the expected kernel or + // module code range. UnexpectedKprobeHandler bool `json:"unexpectedKprobeHandler,omitempty"` - // UnexpectedProcessesInRunqueue: Flag indicating unexpected process(es) - // in the scheduler run-queue, those that are in the run-queue, but not - // in the process task-list. + // UnexpectedProcessesInRunqueue: True when unexpected processes in the + // scheduler run queue are present. Such processes are in the run queue, + // but not in the process task list. UnexpectedProcessesInRunqueue bool `json:"unexpectedProcessesInRunqueue,omitempty"` // UnexpectedReadOnlyDataModification: Flag indicating unexpected // modifications of kernel read-only data memory. UnexpectedReadOnlyDataModification bool `json:"unexpectedReadOnlyDataModification,omitempty"` - // UnexpectedSystemCallHandler: Flag indicating presence of system call - // handlers that are are not in the expected kernel, module code - // regions. + // UnexpectedSystemCallHandler: True when system call handlers that are + // are not in the expected kernel or module code regions are present. UnexpectedSystemCallHandler bool `json:"unexpectedSystemCallHandler,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json index 1232e0b6e8c..984d00bda4a 100644 --- a/speech/v1/speech-api.json +++ b/speech/v1/speech-api.json @@ -524,9 +524,22 @@ } } }, - "revision": "20221020", + "revision": "20221202", "rootUrl": "https://speech.googleapis.com/", "schemas": { + "ABNFGrammar": { + "id": "ABNFGrammar", + "properties": { + "abnfStrings": { + "description": "All declarations and rules of an ABNF grammar broken up into multiple strings that will end up concatenated.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ClassItem": { "description": "An item of the class.", "id": "ClassItem", @@ -1112,6 +1125,10 @@ "description": "Speech adaptation configuration.", "id": "SpeechAdaptation", "properties": { + "abnfGrammar": { + "$ref": "ABNFGrammar", + "description": "Augmented Backus-Naur form (ABNF) is a standardized grammar notation comprised by a set of derivation rules. See specifications: https://www.w3.org/TR/speech-grammar" + }, "customClasses": { "description": "A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`.", "items": { diff --git a/speech/v1/speech-gen.go b/speech/v1/speech-gen.go index d0f256ab787..7d1cbb13409 100644 --- a/speech/v1/speech-gen.go +++ b/speech/v1/speech-gen.go @@ -208,6 +208,34 @@ type SpeechService struct { s *Service } +type ABNFGrammar struct { + // AbnfStrings: All declarations and rules of an ABNF grammar broken up + // into multiple strings that will end up concatenated. + AbnfStrings []string `json:"abnfStrings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AbnfStrings") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AbnfStrings") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ABNFGrammar) MarshalJSON() ([]byte, error) { + type NoMethod ABNFGrammar + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ClassItem: An item of the class. type ClassItem struct { // Value: The class item's value. @@ -1308,6 +1336,11 @@ func (s *SpeakerDiarizationConfig) MarshalJSON() ([]byte, error) { // SpeechAdaptation: Speech adaptation configuration. type SpeechAdaptation struct { + // AbnfGrammar: Augmented Backus-Naur form (ABNF) is a standardized + // grammar notation comprised by a set of derivation rules. See + // specifications: https://www.w3.org/TR/speech-grammar + AbnfGrammar *ABNFGrammar `json:"abnfGrammar,omitempty"` + // CustomClasses: A collection of custom classes. To specify the classes // inline, leave the class' `name` blank and fill in the rest of its // fields, giving it a unique `custom_class_id`. Refer to the inline @@ -1323,7 +1356,7 @@ type SpeechAdaptation struct { // fields. Any phrase set can use any custom class. PhraseSets []*PhraseSet `json:"phraseSets,omitempty"` - // ForceSendFields is a list of field names (e.g. "CustomClasses") to + // ForceSendFields is a list of field names (e.g. "AbnfGrammar") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -1331,7 +1364,7 @@ type SpeechAdaptation struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CustomClasses") to include + // NullFields is a list of field names (e.g. "AbnfGrammar") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as diff --git a/speech/v1p1beta1/speech-api.json b/speech/v1p1beta1/speech-api.json index 4c5c99b537b..1e52679c5f2 100644 --- a/speech/v1p1beta1/speech-api.json +++ b/speech/v1p1beta1/speech-api.json @@ -524,9 +524,22 @@ } } }, - "revision": "20221020", + "revision": "20221202", "rootUrl": "https://speech.googleapis.com/", "schemas": { + "ABNFGrammar": { + "id": "ABNFGrammar", + "properties": { + "abnfStrings": { + "description": "All declarations and rules of an ABNF grammar broken up into multiple strings that will end up concatenated.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ClassItem": { "description": "An item of the class.", "id": "ClassItem", @@ -1156,6 +1169,10 @@ "description": "Speech adaptation configuration.", "id": "SpeechAdaptation", "properties": { + "abnfGrammar": { + "$ref": "ABNFGrammar", + "description": "Augmented Backus-Naur form (ABNF) is a standardized grammar notation comprised by a set of derivation rules. See specifications: https://www.w3.org/TR/speech-grammar" + }, "customClasses": { "description": "A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`.", "items": { diff --git a/speech/v1p1beta1/speech-gen.go b/speech/v1p1beta1/speech-gen.go index b0b892819b7..1efe64f906d 100644 --- a/speech/v1p1beta1/speech-gen.go +++ b/speech/v1p1beta1/speech-gen.go @@ -208,6 +208,34 @@ type SpeechService struct { s *Service } +type ABNFGrammar struct { + // AbnfStrings: All declarations and rules of an ABNF grammar broken up + // into multiple strings that will end up concatenated. + AbnfStrings []string `json:"abnfStrings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AbnfStrings") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AbnfStrings") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ABNFGrammar) MarshalJSON() ([]byte, error) { + type NoMethod ABNFGrammar + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ClassItem: An item of the class. type ClassItem struct { // Value: The class item's value. @@ -1373,6 +1401,11 @@ func (s *SpeakerDiarizationConfig) MarshalJSON() ([]byte, error) { // SpeechAdaptation: Speech adaptation configuration. type SpeechAdaptation struct { + // AbnfGrammar: Augmented Backus-Naur form (ABNF) is a standardized + // grammar notation comprised by a set of derivation rules. See + // specifications: https://www.w3.org/TR/speech-grammar + AbnfGrammar *ABNFGrammar `json:"abnfGrammar,omitempty"` + // CustomClasses: A collection of custom classes. To specify the classes // inline, leave the class' `name` blank and fill in the rest of its // fields, giving it a unique `custom_class_id`. Refer to the inline @@ -1388,7 +1421,7 @@ type SpeechAdaptation struct { // fields. Any phrase set can use any custom class. PhraseSets []*PhraseSet `json:"phraseSets,omitempty"` - // ForceSendFields is a list of field names (e.g. "CustomClasses") to + // ForceSendFields is a list of field names (e.g. "AbnfGrammar") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -1396,7 +1429,7 @@ type SpeechAdaptation struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CustomClasses") to include + // NullFields is a list of field names (e.g. "AbnfGrammar") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json index 5e938cbff22..96b07c0a16d 100644 --- a/storagetransfer/v1/storagetransfer-api.json +++ b/storagetransfer/v1/storagetransfer-api.json @@ -632,7 +632,7 @@ } } }, - "revision": "20220921", + "revision": "20221201", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -895,6 +895,27 @@ }, "type": "object" }, + "EventStream": { + "description": "Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.", + "id": "EventStream", + "properties": { + "eventStreamExpirationTime": { + "description": "Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.", + "format": "google-datetime", + "type": "string" + }, + "eventStreamStartTime": { + "description": "Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Required. Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.", + "type": "string" + } + }, + "type": "object" + }, "GcsData": { "description": "In a GcsData resource, an object's name is the Cloud Storage object's name and its \"last modification time\" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.", "id": "GcsData", @@ -1609,6 +1630,10 @@ "description": "A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.", "type": "string" }, + "eventStream": { + "$ref": "EventStream", + "description": "Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored." + }, "lastModificationTime": { "description": "Output only. The time that the transfer job was last modified.", "format": "google-datetime", @@ -1719,7 +1744,8 @@ "SUCCESS", "FAILED", "ABORTED", - "QUEUED" + "QUEUED", + "SUSPENDING" ], "enumDescriptions": [ "Zero is an illegal value.", @@ -1728,7 +1754,8 @@ "Completed successfully.", "Terminated due to an unrecoverable failure.", "Aborted by the user.", - "Temporarily delayed by the system. No user action is required." + "Temporarily delayed by the system. No user action is required.", + "The operation is suspending and draining the ongoing work to completion." ], "type": "string" }, diff --git a/storagetransfer/v1/storagetransfer-gen.go b/storagetransfer/v1/storagetransfer-gen.go index 4b06dc8fbe5..8d6b4c6f30f 100644 --- a/storagetransfer/v1/storagetransfer-gen.go +++ b/storagetransfer/v1/storagetransfer-gen.go @@ -715,6 +715,53 @@ func (s *ErrorSummary) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// EventStream: Specifies the Event-driven transfer options. +// Event-driven transfers listen to an event stream to transfer updated +// files. +type EventStream struct { + // EventStreamExpirationTime: Specifies the data and time at which + // Storage Transfer Service stops listening for events from this stream. + // After this time, any transfers in progress will complete, but no new + // transfers are initiated. + EventStreamExpirationTime string `json:"eventStreamExpirationTime,omitempty"` + + // EventStreamStartTime: Specifies the date and time that Storage + // Transfer Service starts listening for events from this stream. If no + // start time is specified or start time is in the past, Storage + // Transfer Service starts listening immediately. + EventStreamStartTime string `json:"eventStreamStartTime,omitempty"` + + // Name: Required. Specifies a unique name of the resource such as AWS + // SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or + // Pub/Sub subscription resource name in the form + // 'projects/{project}/subscriptions/{sub}'. + Name string `json:"name,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EventStreamExpirationTime") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "EventStreamExpirationTime") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *EventStream) MarshalJSON() ([]byte, error) { + type NoMethod EventStream + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GcsData: In a GcsData resource, an object's name is the Cloud Storage // object's name and its "last modification time" refers to the object's // `updated` property of Cloud Storage objects, which changes when the @@ -1828,6 +1875,11 @@ type TransferJob struct { // length is 1024 bytes when Unicode-encoded. Description string `json:"description,omitempty"` + // EventStream: Specifies the event stream for the transfer job for + // event-driven transfers. When EventStream is specified, the Schedule + // fields are ignored. + EventStream *EventStream `json:"eventStream,omitempty"` + // LastModificationTime: Output only. The time that the transfer job was // last modified. LastModificationTime string `json:"lastModificationTime,omitempty"` @@ -1984,6 +2036,8 @@ type TransferOperation struct { // "ABORTED" - Aborted by the user. // "QUEUED" - Temporarily delayed by the system. No user action is // required. + // "SUSPENDING" - The operation is suspending and draining the ongoing + // work to completion. Status string `json:"status,omitempty"` // TransferJobName: The name of the transfer job that triggers this