diff --git a/admin/directory/v1/admin-api.json b/admin/directory/v1/admin-api.json index f106f0346a7..71d50fbee8b 100644 --- a/admin/directory/v1/admin-api.json +++ b/admin/directory/v1/admin-api.json @@ -4671,7 +4671,7 @@ } } }, - "revision": "20240102", + "revision": "20240220", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6165,7 +6165,7 @@ "type": "string" }, "payload": { - "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`.", + "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The delay has to be in the range [0, 300].", "type": "string" } }, diff --git a/admin/directory/v1/admin-gen.go b/admin/directory/v1/admin-gen.go index 22055e5dbb7..4756b6a2e1a 100644 --- a/admin/directory/v1/admin-gen.go +++ b/admin/directory/v1/admin-gen.go @@ -2939,7 +2939,10 @@ type DirectoryChromeosdevicesIssueCommandRequest struct { // JSON object in the form: { "ackedUserPresence": true }. // `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is // set to `false`. To start a Chrome Remote Desktop session for an - // active device, set `ackedUserPresence` to `true`. + // active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload + // is a stringified JSON object in the form: { + // "user_session_delay_seconds": 300 }. The delay has to be in the range + // [0, 300]. Payload string `json:"payload,omitempty"` // ForceSendFields is a list of field names (e.g. "CommandType") to diff --git a/admin/reports/v1/admin-api.json b/admin/reports/v1/admin-api.json index bc9695f515a..359945838fb 100644 --- a/admin/reports/v1/admin-api.json +++ b/admin/reports/v1/admin-api.json @@ -360,7 +360,8 @@ }, "orgUnitID": { "default": "", - "description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.", + "deprecated": true, + "description": "`Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.", "location": "query", "pattern": "(id:[a-z0-9]+)", "type": "string" @@ -625,7 +626,7 @@ } } }, - "revision": "20240130", + "revision": "20240220", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/admin/reports/v1/admin-gen.go b/admin/reports/v1/admin-gen.go index a2415aa5715..a2d90fcca9d 100644 --- a/admin/reports/v1/admin-gen.go +++ b/admin/reports/v1/admin-gen.go @@ -1515,7 +1515,8 @@ func (c *ActivitiesWatchCall) MaxResults(maxResults int64) *ActivitiesWatchCall return c } -// OrgUnitID sets the optional parameter "orgUnitID": ID of the +// OrgUnitID sets the optional parameter "orgUnitID": `Deprecated`. This +// field is deprecated and is no longer supported. ID of the // organizational unit to report on. Activity records will be shown only // for users who belong to the specified organizational unit. Data // before Dec 17, 2018 doesn't appear in the filtered results. @@ -1744,7 +1745,8 @@ func (c *ActivitiesWatchCall) Do(opts ...googleapi.CallOption) (*Channel, error) // }, // "orgUnitID": { // "default": "", - // "description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.", + // "deprecated": true, + // "description": "`Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.", // "location": "query", // "pattern": "(id:[a-z0-9]+)", // "type": "string" diff --git a/cloudasset/v1/cloudasset-api.json b/cloudasset/v1/cloudasset-api.json index 8778fdb01a7..f74db72c75f 100644 --- a/cloudasset/v1/cloudasset-api.json +++ b/cloudasset/v1/cloudasset-api.json @@ -204,7 +204,7 @@ "type": "string" }, "scope": { - "description": "Required. Only IAM policies on or below the scope will be returned. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "description": "Required. Only IAM policies on or below the scope will be returned. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -628,7 +628,7 @@ "type": "string" }, "scope": { - "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -653,7 +653,7 @@ ], "parameters": { "scope": { - "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -1095,7 +1095,7 @@ } } }, - "revision": "20240130", + "revision": "20240217", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1527,7 +1527,7 @@ "type": "object" }, "ConditionEvaluation": { - "description": "The Condition evaluation.", + "description": "The condition evaluation.", "id": "ConditionEvaluation", "properties": { "evaluationValue": { @@ -1542,7 +1542,7 @@ "Reserved for future use.", "The evaluation result is `true`.", "The evaluation result is `false`.", - "The evaluation result is `conditional` when the condition expression contains variables that are either missing input values or have not been supported by Analyzer yet." + "The evaluation result is `conditional` when the condition expression contains variables that are either missing input values or have not been supported by Policy Analyzer yet." ], "type": "string" } @@ -2271,7 +2271,7 @@ }, "conditionEvaluation": { "$ref": "ConditionEvaluation", - "description": "The condition evaluation result for this rule. Only populated if it meets all the following criteria: * there is a condition defined for this rule * this rule is within a consolidated_policy * the consolidated_policy is within AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer or AnalyzeOrgPolicyGovernedAssetsResponse.GovernedResource" + "description": "The condition evaluation result for this rule. Only populated if it meets all the following criteria: * There is a condition defined for this rule. * This rule is within AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer.consolidated_policy, or AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset.consolidated_policy when the AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset has AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset.governed_resource." }, "denyAll": { "description": "Setting this to true means that all values are denied. This field can be set only in Policies for list constraints.", @@ -2283,7 +2283,7 @@ }, "values": { "$ref": "GoogleCloudAssetV1StringValues", - "description": "List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints." + "description": "List of values to be used for this policy rule. This field can be set only in policies for list constraints." } }, "type": "object" @@ -3243,7 +3243,7 @@ "description": "Optional. Specifies a resource for analysis." }, "scope": { - "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", "type": "string" } }, @@ -4444,7 +4444,7 @@ "type": "object" }, "Tag": { - "description": "The key and value for a [tag](https://cloud.google.com/resource-manager/docs/tags/tags-overview),", + "description": "The key and value for a [tag](https://cloud.google.com/resource-manager/docs/tags/tags-overview).", "id": "Tag", "properties": { "tagKey": { diff --git a/cloudasset/v1/cloudasset-gen.go b/cloudasset/v1/cloudasset-gen.go index 14d3fd939b6..42f71c29747 100644 --- a/cloudasset/v1/cloudasset-gen.go +++ b/cloudasset/v1/cloudasset-gen.go @@ -1176,7 +1176,7 @@ func (s *ConditionContext) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ConditionEvaluation: The Condition evaluation. +// ConditionEvaluation: The condition evaluation. type ConditionEvaluation struct { // EvaluationValue: The evaluation result. // @@ -1186,7 +1186,7 @@ type ConditionEvaluation struct { // "FALSE" - The evaluation result is `false`. // "CONDITIONAL" - The evaluation result is `conditional` when the // condition expression contains variables that are either missing input - // values or have not been supported by Analyzer yet. + // values or have not been supported by Policy Analyzer yet. EvaluationValue string `json:"evaluationValue,omitempty"` // ForceSendFields is a list of field names (e.g. "EvaluationValue") to @@ -2572,11 +2572,14 @@ type GoogleCloudAssetV1Rule struct { Condition *Expr `json:"condition,omitempty"` // ConditionEvaluation: The condition evaluation result for this rule. - // Only populated if it meets all the following criteria: * there is a - // condition defined for this rule * this rule is within a - // consolidated_policy * the consolidated_policy is within - // AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer or - // AnalyzeOrgPolicyGovernedAssetsResponse.GovernedResource + // Only populated if it meets all the following criteria: * There is a + // condition defined for this rule. * This rule is within + // AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer.consolida + // ted_policy, or + // AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset.consolidated_poli + // cy when the AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset has + // AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset.governed_resource + // . ConditionEvaluation *ConditionEvaluation `json:"conditionEvaluation,omitempty"` // DenyAll: Setting this to true means that all values are denied. This @@ -2588,8 +2591,8 @@ type GoogleCloudAssetV1Rule struct { // Policies for boolean constraints. Enforce bool `json:"enforce,omitempty"` - // Values: List of values to be used for this PolicyRule. This field can - // be set only in Policies for list constraints. + // Values: List of values to be used for this policy rule. This field + // can be set only in policies for list constraints. Values *GoogleCloudAssetV1StringValues `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "AllowAll") to @@ -4435,9 +4438,9 @@ type IamPolicyAnalysisQuery struct { // an organization number (such as "organizations/123"), a folder number // (such as "folders/123"), a project ID (such as // "projects/my-project-id"), or a project number (such as - // "projects/12345"). To know how to get organization id, visit here + // "projects/12345"). To know how to get organization ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). - // To know how to get folder or project id, visit here + // To know how to get folder or project ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects). Scope string `json:"scope,omitempty"` @@ -6756,7 +6759,7 @@ func (s *TableSchema) MarshalJSON() ([]byte, error) { } // Tag: The key and value for a tag -// (https://cloud.google.com/resource-manager/docs/tags/tags-overview), +// (https://cloud.google.com/resource-manager/docs/tags/tags-overview). type Tag struct { // TagKey: TagKey namespaced name, in the format of // {ORG_ID}/{TAG_KEY_SHORT_NAME}. @@ -7543,10 +7546,10 @@ type EffectiveIamPoliciesBatchGetCall struct { // This can only be an organization number (such as // "organizations/123"), a folder number (such as "folders/123"), a // project ID (such as "projects/my-project-id"), or a project number -// (such as "projects/12345"). To know how to get organization id, +// (such as "projects/12345"). To know how to get organization ID, // visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). -// To know how to get folder or project id, visit here +// To know how to get folder or project ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects). func (r *EffectiveIamPoliciesService) BatchGet(scope string) *EffectiveIamPoliciesBatchGetCall { c := &EffectiveIamPoliciesBatchGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7681,7 +7684,7 @@ func (c *EffectiveIamPoliciesBatchGetCall) Do(opts ...googleapi.CallOption) (*Ba // "type": "string" // }, // "scope": { - // "description": "Required. Only IAM policies on or below the scope will be returned. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + // "description": "Required. Only IAM policies on or below the scope will be returned. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", // "location": "path", // "pattern": "^[^/]+/[^/]+$", // "required": true, @@ -9418,9 +9421,9 @@ type V1AnalyzeIamPolicyCall struct { // organization number (such as "organizations/123"), a folder number // (such as "folders/123"), a project ID (such as // "projects/my-project-id"), or a project number (such as -// "projects/12345"). To know how to get organization id, visit here +// "projects/12345"). To know how to get organization ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). -// To know how to get folder or project id, visit here +// To know how to get folder or project ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects). func (r *V1Service) AnalyzeIamPolicy(scope string) *V1AnalyzeIamPolicyCall { c := &V1AnalyzeIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -9788,7 +9791,7 @@ func (c *V1AnalyzeIamPolicyCall) Do(opts ...googleapi.CallOption) (*AnalyzeIamPo // "type": "string" // }, // "scope": { - // "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + // "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", // "location": "path", // "pattern": "^[^/]+/[^/]+$", // "required": true, @@ -9832,9 +9835,9 @@ type V1AnalyzeIamPolicyLongrunningCall struct { // organization number (such as "organizations/123"), a folder number // (such as "folders/123"), a project ID (such as // "projects/my-project-id"), or a project number (such as -// "projects/12345"). To know how to get organization id, visit here +// "projects/12345"). To know how to get organization ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). -// To know how to get folder or project id, visit here +// To know how to get folder or project ID, visit here // (https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects). func (r *V1Service) AnalyzeIamPolicyLongrunning(scope string, analyzeiampolicylongrunningrequest *AnalyzeIamPolicyLongrunningRequest) *V1AnalyzeIamPolicyLongrunningCall { c := &V1AnalyzeIamPolicyLongrunningCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -9943,7 +9946,7 @@ func (c *V1AnalyzeIamPolicyLongrunningCall) Do(opts ...googleapi.CallOption) (*O // ], // "parameters": { // "scope": { - // "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + // "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project ID, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", // "location": "path", // "pattern": "^[^/]+/[^/]+$", // "required": true, diff --git a/compute/v0.alpha/compute-api.json b/compute/v0.alpha/compute-api.json index c039df45229..1057518d248 100644 --- a/compute/v0.alpha/compute-api.json +++ b/compute/v0.alpha/compute-api.json @@ -126,7 +126,7 @@ "acceleratorTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of accelerator types.", + "description": "Retrieves an aggregated list of accelerator types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/acceleratorTypes", "httpMethod": "GET", "id": "compute.acceleratorTypes.aggregatedList", @@ -170,7 +170,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -275,7 +275,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -302,7 +302,7 @@ "addresses": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of addresses.", + "description": "Retrieves an aggregated list of addresses. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/addresses", "httpMethod": "GET", "id": "compute.addresses.aggregatedList", @@ -346,7 +346,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -547,7 +547,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -713,7 +713,7 @@ "autoscalers": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of autoscalers.", + "description": "Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/autoscalers", "httpMethod": "GET", "id": "compute.autoscalers.aggregatedList", @@ -757,7 +757,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -951,7 +951,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -1394,7 +1394,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -1655,7 +1655,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/backendServices", "httpMethod": "GET", "id": "compute.backendServices.aggregatedList", @@ -1699,7 +1699,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -1991,7 +1991,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -2046,7 +2046,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -2394,7 +2394,7 @@ "diskTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of disk types.", + "description": "Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/diskTypes", "httpMethod": "GET", "id": "compute.diskTypes.aggregatedList", @@ -2438,7 +2438,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -2543,7 +2543,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -2620,7 +2620,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of persistent disks.", + "description": "Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/disks", "httpMethod": "GET", "id": "compute.disks.aggregatedList", @@ -2664,7 +2664,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -3008,7 +3008,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -3623,7 +3623,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -4046,7 +4046,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -4477,7 +4477,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -4619,7 +4619,7 @@ "forwardingRules": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of forwarding rules.", + "description": "Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/forwardingRules", "httpMethod": "GET", "id": "compute.forwardingRules.aggregatedList", @@ -4663,7 +4663,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -4864,7 +4864,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -5080,7 +5080,7 @@ "futureReservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of future reservations.", + "description": "Retrieves an aggregated list of future reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/futureReservations", "httpMethod": "GET", "id": "compute.futureReservations.aggregatedList", @@ -5124,7 +5124,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -5358,7 +5358,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -5622,7 +5622,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -5906,7 +5906,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -6312,7 +6312,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -6374,7 +6374,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -6394,7 +6394,7 @@ "globalOperations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of all operations.", + "description": "Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/operations", "httpMethod": "GET", "id": "compute.globalOperations.aggregatedList", @@ -6438,7 +6438,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -6565,7 +6565,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -6714,7 +6714,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -6881,7 +6881,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -6943,7 +6943,7 @@ "healthChecks": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/healthChecks", "httpMethod": "GET", "id": "compute.healthChecks.aggregatedList", @@ -6987,7 +6987,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -7156,7 +7156,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -7445,7 +7445,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -7734,7 +7734,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -8196,7 +8196,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -8623,7 +8623,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -8697,7 +8697,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of managed instance groups and groups them by zone.", + "description": "Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/instanceGroupManagers", "httpMethod": "GET", "id": "compute.instanceGroupManagers.aggregatedList", @@ -8741,7 +8741,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -9112,7 +9112,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -9181,7 +9181,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -9250,7 +9250,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -9319,7 +9319,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -10117,7 +10117,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of instance groups and sorts them by zone.", + "description": "Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/instanceGroups", "httpMethod": "GET", "id": "compute.instanceGroups.aggregatedList", @@ -10161,7 +10161,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -10350,7 +10350,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -10419,7 +10419,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -10676,7 +10676,7 @@ "instanceTemplates": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/instanceTemplates", "httpMethod": "GET", "id": "compute.instanceTemplates.aggregatedList", @@ -10720,7 +10720,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -10945,7 +10945,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -11211,7 +11211,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.", + "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/instances", "httpMethod": "GET", "id": "compute.instances.aggregatedList", @@ -11255,7 +11255,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -12131,7 +12131,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -12217,7 +12217,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -13943,7 +13943,7 @@ "instantSnapshots": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of instantSnapshots.", + "description": "Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/instantSnapshots", "httpMethod": "GET", "id": "compute.instantSnapshots.aggregatedList", @@ -13987,7 +13987,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -14230,7 +14230,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -14398,7 +14398,7 @@ "interconnectAttachments": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of interconnect attachments.", + "description": "Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/interconnectAttachments", "httpMethod": "GET", "id": "compute.interconnectAttachments.aggregatedList", @@ -14442,7 +14442,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -14697,7 +14697,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -14982,7 +14982,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -15114,7 +15114,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -15430,7 +15430,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -15950,7 +15950,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -16238,7 +16238,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -16333,7 +16333,7 @@ "machineTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of machine types.", + "description": "Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/machineTypes", "httpMethod": "GET", "id": "compute.machineTypes.aggregatedList", @@ -16377,7 +16377,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -16482,7 +16482,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -16509,7 +16509,7 @@ "networkAttachments": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/networkAttachments", "httpMethod": "GET", "id": "compute.networkAttachments.aggregatedList", @@ -16553,7 +16553,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -16803,7 +16803,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -16964,7 +16964,7 @@ "networkEdgeSecurityServices": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.", + "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices", "httpMethod": "GET", "id": "compute.networkEdgeSecurityServices.aggregatedList", @@ -17008,7 +17008,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -17232,7 +17232,7 @@ "networkEndpointGroups": { "methods": { "aggregatedList": { - "description": "Retrieves the list of network endpoint groups and sorts them by zone.", + "description": "Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/networkEndpointGroups", "httpMethod": "GET", "id": "compute.networkEndpointGroups.aggregatedList", @@ -17276,7 +17276,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -17561,7 +17561,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -17630,7 +17630,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -18125,7 +18125,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -18665,7 +18665,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -18728,7 +18728,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -18811,7 +18811,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -18909,7 +18909,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -19182,7 +19182,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.", + "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/nodeGroups", "httpMethod": "GET", "id": "compute.nodeGroups.aggregatedList", @@ -19226,7 +19226,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -19527,7 +19527,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -19598,7 +19598,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -19916,7 +19916,7 @@ "nodeTemplates": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of node templates.", + "description": "Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/nodeTemplates", "httpMethod": "GET", "id": "compute.nodeTemplates.aggregatedList", @@ -19960,7 +19960,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -20210,7 +20210,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -20321,7 +20321,7 @@ "nodeTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of node types.", + "description": "Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/nodeTypes", "httpMethod": "GET", "id": "compute.nodeTypes.aggregatedList", @@ -20365,7 +20365,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -20470,7 +20470,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -20792,7 +20792,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -21017,7 +21017,7 @@ "packetMirrorings": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of packetMirrorings.", + "description": "Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/packetMirrorings", "httpMethod": "GET", "id": "compute.packetMirrorings.aggregatedList", @@ -21061,7 +21061,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -21262,7 +21262,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -21600,7 +21600,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -21654,7 +21654,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -21740,6 +21740,40 @@ "https://www.googleapis.com/auth/compute" ] }, + "setCloudArmorTier": { + "description": "Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.", + "flatPath": "projects/{project}/setCloudArmorTier", + "httpMethod": "POST", + "id": "compute.projects.setCloudArmorTier", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/setCloudArmorTier", + "request": { + "$ref": "ProjectsSetCloudArmorTierRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setCommonInstanceMetadata": { "description": "Sets metadata common to all instances within the specified project using the data included in the request.", "flatPath": "projects/{project}/setCommonInstanceMetadata", @@ -22103,7 +22137,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -22203,7 +22237,7 @@ "publicDelegatedPrefixes": { "methods": { "aggregatedList": { - "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.", + "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes", "httpMethod": "GET", "id": "compute.publicDelegatedPrefixes.aggregatedList", @@ -22247,7 +22281,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -22493,7 +22527,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -22787,7 +22821,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -23222,7 +23256,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -23284,7 +23318,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -23544,7 +23578,7 @@ "regionCommitments": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of commitments by region.", + "description": "Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/commitments", "httpMethod": "GET", "id": "compute.regionCommitments.aggregatedList", @@ -23588,7 +23622,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -23836,7 +23870,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -24190,7 +24224,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -24589,7 +24623,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -25050,7 +25084,7 @@ "regionHealthCheckServices": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/healthCheckServices", "httpMethod": "GET", "id": "compute.regionHealthCheckServices.aggregatedList", @@ -25094,7 +25128,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -25293,7 +25327,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -25587,7 +25621,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -26156,7 +26190,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -26225,7 +26259,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -26294,7 +26328,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -26363,7 +26397,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -27195,7 +27229,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -27264,7 +27298,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -27575,7 +27609,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -27884,7 +27918,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -28314,7 +28348,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -28383,7 +28417,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -28945,7 +28979,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -29361,7 +29395,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -29562,7 +29596,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -29757,7 +29791,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -30103,7 +30137,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -30609,7 +30643,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -30949,7 +30983,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -31192,7 +31226,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -31255,7 +31289,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -31549,7 +31583,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -31844,7 +31878,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -32239,7 +32273,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -32534,7 +32568,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -32792,7 +32826,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -32886,7 +32920,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -32906,7 +32940,7 @@ "reservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of reservations.", + "description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/reservations", "httpMethod": "GET", "id": "compute.reservations.aggregatedList", @@ -32950,7 +32984,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -33193,7 +33227,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -33422,7 +33456,7 @@ "resourcePolicies": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of resource policies.", + "description": "Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/resourcePolicies", "httpMethod": "GET", "id": "compute.resourcePolicies.aggregatedList", @@ -33466,7 +33500,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -33716,7 +33750,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -33888,7 +33922,7 @@ "routers": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of routers.", + "description": "Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/routers", "httpMethod": "GET", "id": "compute.routers.aggregatedList", @@ -33932,7 +33966,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -34295,7 +34329,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -34497,7 +34531,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -34593,7 +34627,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -34680,7 +34714,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -34751,7 +34785,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -35217,7 +35251,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -35317,7 +35351,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/securityPolicies", "httpMethod": "GET", "id": "compute.securityPolicies.aggregatedList", @@ -35361,7 +35395,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -35576,7 +35610,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -35631,7 +35665,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -35873,7 +35907,7 @@ "serviceAttachments": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/serviceAttachments", "httpMethod": "GET", "id": "compute.serviceAttachments.aggregatedList", @@ -35917,7 +35951,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -36167,7 +36201,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -36397,7 +36431,7 @@ "snapshots": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of all of the snapshots in your project across all regions and global scope.", + "description": "Retrieves an aggregated list of all of the snapshots in your project across all regions and global scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/snapshots", "httpMethod": "GET", "id": "compute.snapshots.aggregatedList", @@ -36441,7 +36475,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -36651,7 +36685,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -36783,7 +36817,7 @@ "sslCertificates": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/sslCertificates", "httpMethod": "GET", "id": "compute.sslCertificates.aggregatedList", @@ -36827,7 +36861,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -36996,7 +37030,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -37054,7 +37088,7 @@ "sslPolicies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/sslPolicies", "httpMethod": "GET", "id": "compute.sslPolicies.aggregatedList", @@ -37098,7 +37132,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -37265,7 +37299,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -37320,7 +37354,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -37419,7 +37453,7 @@ "storagePoolTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of storage pool types.", + "description": "Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/storagePoolTypes", "httpMethod": "GET", "id": "compute.storagePoolTypes.aggregatedList", @@ -37463,7 +37497,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -37568,7 +37602,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -37595,7 +37629,7 @@ "storagePools": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of storage pools.", + "description": "Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/storagePools", "httpMethod": "GET", "id": "compute.storagePools.aggregatedList", @@ -37639,7 +37673,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -37881,7 +37915,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -37945,7 +37979,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -38176,7 +38210,7 @@ "subnetworks": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of subnetworks.", + "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/subnetworks", "httpMethod": "GET", "id": "compute.subnetworks.aggregatedList", @@ -38220,7 +38254,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -38520,7 +38554,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -38575,7 +38609,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -38944,7 +38978,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -39044,7 +39078,7 @@ "targetHttpProxies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/targetHttpProxies", "httpMethod": "GET", "id": "compute.targetHttpProxies.aggregatedList", @@ -39088,7 +39122,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -39257,7 +39291,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -39399,7 +39433,7 @@ "targetHttpsProxies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/targetHttpsProxies", "httpMethod": "GET", "id": "compute.targetHttpsProxies.aggregatedList", @@ -39443,7 +39477,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -39612,7 +39646,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -39919,7 +39953,7 @@ "targetInstances": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of target instances.", + "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/targetInstances", "httpMethod": "GET", "id": "compute.targetInstances.aggregatedList", @@ -39963,7 +39997,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -40157,7 +40191,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -40379,7 +40413,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of target pools.", + "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/targetPools", "httpMethod": "GET", "id": "compute.targetPools.aggregatedList", @@ -40423,7 +40457,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -40670,7 +40704,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -41088,7 +41122,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -41354,7 +41388,7 @@ "targetTcpProxies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/targetTcpProxies", "httpMethod": "GET", "id": "compute.targetTcpProxies.aggregatedList", @@ -41398,7 +41432,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -41567,7 +41601,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -41709,7 +41743,7 @@ "targetVpnGateways": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of target VPN gateways.", + "description": "Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/targetVpnGateways", "httpMethod": "GET", "id": "compute.targetVpnGateways.aggregatedList", @@ -41753,7 +41787,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -41954,7 +41988,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -42070,7 +42104,7 @@ "urlMaps": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project.", + "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/urlMaps", "httpMethod": "GET", "id": "compute.urlMaps.aggregatedList", @@ -42114,7 +42148,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -42325,7 +42359,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -42504,7 +42538,7 @@ "vpnGateways": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of VPN gateways.", + "description": "Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/vpnGateways", "httpMethod": "GET", "id": "compute.vpnGateways.aggregatedList", @@ -42548,7 +42582,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -42792,7 +42826,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -42908,7 +42942,7 @@ "vpnTunnels": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of VPN tunnels.", + "description": "Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/vpnTunnels", "httpMethod": "GET", "id": "compute.vpnTunnels.aggregatedList", @@ -42952,7 +42986,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -43153,7 +43187,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -43391,7 +43425,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -43461,7 +43495,7 @@ "zoneQueuedResources": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of all of the queued resources in a project across all zones.", + "description": "Retrieves an aggregated list of all of the queued resources in a project across all zones. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/queuedResources", "httpMethod": "GET", "id": "compute.zoneQueuedResources.aggregatedList", @@ -43505,7 +43539,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -43744,7 +43778,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, @@ -43845,7 +43879,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } @@ -43863,7 +43897,7 @@ } } }, - "revision": "20240130", + "revision": "20240218", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45624,7 +45658,7 @@ "type": "string" }, "provisionedThroughput": { - "description": "Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124.", + "description": "Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.", "format": "int64", "type": "string" }, @@ -50273,7 +50307,7 @@ "type": "string" }, "provisionedThroughput": { - "description": "Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124.", + "description": "Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.", "format": "int64", "type": "string" }, @@ -50380,14 +50414,16 @@ "DELETING", "FAILED", "READY", - "RESTORING" + "RESTORING", + "UNAVAILABLE" ], "enumDescriptions": [ "Disk is provisioning", "Disk is deleting.", "Disk creation failed.", "Disk is ready for use.", - "Source data is being copied into the disk." + "Source data is being copied into the disk.", + "Disk is currently unavailable and cannot be accessed, attached or detached." ], "type": "string" }, @@ -50892,6 +50928,10 @@ "DiskSettings": { "id": "DiskSettings", "properties": { + "accessLocation": { + "$ref": "DiskSettingsAccessLocation", + "description": "Policy of which locations are allowed to create regional snapshots." + }, "defaultResourcePolicies": { "additionalProperties": { "$ref": "DiskSettingsResourcePolicyDetails" @@ -50902,6 +50942,31 @@ }, "type": "object" }, + "DiskSettingsAccessLocation": { + "description": "AccessLocation is only used for regional snapshot. It contains which regions are allowed to create a regional snapshot from disks located in the given region/zone. It includes key-value pairs designed to store the following structure. The keys should match their corresponding values, which must be provided: access_location: { locations { us-central1 { region: \"us-central1\" }, asia-west2 { region: \"asia-west2\" } } }", + "id": "DiskSettingsAccessLocation", + "properties": { + "locations": { + "additionalProperties": { + "$ref": "DiskSettingsAccessLocationAccessLocationPreference" + }, + "description": "List of regions that can create a regional snapshot from the current region", + "type": "object" + } + }, + "type": "object" + }, + "DiskSettingsAccessLocationAccessLocationPreference": { + "description": "A structure for specifying an allowed target region to create snapshot.", + "id": "DiskSettingsAccessLocationAccessLocationPreference", + "properties": { + "region": { + "description": "Accessible region name", + "type": "string" + } + }, + "type": "object" + }, "DiskSettingsResourcePolicyDetails": { "description": "This is the object for storing the detail information about the Resource Policy that will be set as default ones for the Disks that is using the DiskSettings. It contains: - one target Resource Policy referenced by its Fully-Qualified URL, - [output only] Disk Types that will be excluded from using this Resource Policy, - Other filtering support (e.g. Label filtering) for Default Resource Policy can be added here as well", "id": "DiskSettingsResourcePolicyDetails", @@ -53856,6 +53921,10 @@ "$ref": "ShareSettings", "description": "List of Projects/Folders to share with." }, + "specificReservationRequired": { + "description": "Indicates whether the auto-created reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation.", + "type": "boolean" + }, "specificSkuProperties": { "$ref": "FutureReservationSpecificSKUProperties", "description": "Future Reservation configuration to indicate instance properties and total count." @@ -59011,6 +59080,10 @@ }, "description": "Named instance selections configuring properties that the group will use when creating new VMs.", "type": "object" + }, + "provisioningModelMix": { + "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix", + "description": "Provisioning model configuration used by this managed instance group to create instances." } }, "type": "object" @@ -59033,6 +59106,22 @@ }, "type": "object" }, + "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix": { + "id": "InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix", + "properties": { + "standardCapacityBase": { + "description": "The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity user needs. MIG will create only Standard VMs until it reaches standard_capacity_base and only then will start using standard_capacity_percent_above_base to mix Spot with Standard VMs.", + "format": "int32", + "type": "integer" + }, + "standardCapacityPercentAboveBase": { + "description": "The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standard_capacity_base.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "InstanceGroupManagerInstanceLifecyclePolicy": { "id": "InstanceGroupManagerInstanceLifecyclePolicy", "properties": { @@ -67205,6 +67294,18 @@ "machineType": { "description": "The machine type to be used for this instance.", "type": "string" + }, + "provisioningModel": { + "description": "The provisioning model to be used for this instance.", + "enum": [ + "SPOT", + "STANDARD" + ], + "enumDescriptions": [ + "Heavily discounted, no guaranteed runtime.", + "Standard provisioning with user controlled runtime, no discounts." + ], + "type": "string" } }, "type": "object" @@ -74656,6 +74757,20 @@ "description": "Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.", "id": "Project", "properties": { + "cloudArmorTier": { + "description": "[Output Only] The Cloud Armor tier for this project. It can be one of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this field is not specified, it is assumed to be CA_STANDARD.", + "enum": [ + "CA_ENTERPRISE_ANNUAL", + "CA_ENTERPRISE_PAYGO", + "CA_STANDARD" + ], + "enumDescriptions": [ + "Enterprise tier protection billed annually.", + "Enterprise tier protection billed monthly.", + "Standard protection." + ], + "type": "string" + }, "commonInstanceMetadata": { "$ref": "Metadata", "description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information." @@ -74827,6 +74942,26 @@ }, "type": "object" }, + "ProjectsSetCloudArmorTierRequest": { + "id": "ProjectsSetCloudArmorTierRequest", + "properties": { + "cloudArmorTier": { + "description": "Managed protection tier to be set.", + "enum": [ + "CA_ENTERPRISE_ANNUAL", + "CA_ENTERPRISE_PAYGO", + "CA_STANDARD" + ], + "enumDescriptions": [ + "Enterprise tier protection billed annually.", + "Enterprise tier protection billed monthly.", + "Standard protection." + ], + "type": "string" + } + }, + "type": "object" + }, "ProjectsSetDefaultNetworkTierRequest": { "id": "ProjectsSetDefaultNetworkTierRequest", "properties": { @@ -83299,6 +83434,9 @@ ], "type": "string" }, + "onInstanceStopAction": { + "$ref": "SchedulingOnInstanceStopAction" + }, "preemptible": { "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.", "type": "boolean" @@ -83369,6 +83507,17 @@ }, "type": "object" }, + "SchedulingOnInstanceStopAction": { + "description": "Defines the behaviour for instances with the instance_termination_action STOP.", + "id": "SchedulingOnInstanceStopAction", + "properties": { + "discardLocalSsd": { + "description": "If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time.", + "type": "boolean" + } + }, + "type": "object" + }, "Screenshot": { "description": "An instance's screenshot.", "id": "Screenshot", @@ -88689,14 +88838,16 @@ "DELETING", "FAILED", "READY", - "RESTORING" + "RESTORING", + "UNAVAILABLE" ], "enumDescriptions": [ "Disk is provisioning", "Disk is deleting.", "Disk creation failed.", "Disk is ready for use.", - "Source data is being copied into the disk." + "Source data is being copied into the disk.", + "Disk is currently unavailable and cannot be accessed, attached or detached." ], "type": "string" }, diff --git a/compute/v0.alpha/compute-gen.go b/compute/v0.alpha/compute-gen.go index b603c461c8a..14a22d03d0c 100644 --- a/compute/v0.alpha/compute-gen.go +++ b/compute/v0.alpha/compute-gen.go @@ -3801,7 +3801,7 @@ type AttachedDiskInitializeParams struct { // ProvisionedThroughput: Indicates how much throughput to provision for // the disk. This sets the number of throughput mb per second that the - // disk can handle. Values must be between 1 and 7,124. + // disk can handle. Values must greater than or equal to 1. ProvisionedThroughput int64 `json:"provisionedThroughput,omitempty,string"` // ReplicaZones: Required for each regional disk associated with the @@ -10841,7 +10841,7 @@ type Disk struct { // ProvisionedThroughput: Indicates how much throughput to provision for // the disk. This sets the number of throughput mb per second that the - // disk can handle. Values must be between 1 and 7,124. + // disk can handle. Values must be greater than or equal to 1. ProvisionedThroughput int64 `json:"provisionedThroughput,omitempty,string"` // Region: [Output Only] URL of the region where the disk resides. Only @@ -11000,6 +11000,8 @@ type Disk struct { // "FAILED" - Disk creation failed. // "READY" - Disk is ready for use. // "RESTORING" - Source data is being copied into the disk. + // "UNAVAILABLE" - Disk is currently unavailable and cannot be + // accessed, attached or detached. Status string `json:"status,omitempty"` // StoragePool: The storage pool in which the new disk is created. You @@ -11756,6 +11758,10 @@ func (s *DiskResourceStatusAsyncReplicationStatus) MarshalJSON() ([]byte, error) } type DiskSettings struct { + // AccessLocation: Policy of which locations are allowed to create + // regional snapshots. + AccessLocation *DiskSettingsAccessLocation `json:"accessLocation,omitempty"` + // DefaultResourcePolicies: An optional parameter for storing the // default resource policies that will be used for the Disks created in // the given scope. The Key is a string type, provided by customers to @@ -11768,19 +11774,18 @@ type DiskSettings struct { // server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. - // "DefaultResourcePolicies") 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. "AccessLocation") 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. "DefaultResourcePolicies") - // 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 + // NullFields is a list of field names (e.g. "AccessLocation") 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. @@ -11793,6 +11798,70 @@ func (s *DiskSettings) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// DiskSettingsAccessLocation: AccessLocation is only used for regional +// snapshot. It contains which regions are allowed to create a regional +// snapshot from disks located in the given region/zone. It includes +// key-value pairs designed to store the following structure. The keys +// should match their corresponding values, which must be provided: +// access_location: { locations { us-central1 { region: "us-central1" }, +// asia-west2 { region: "asia-west2" } } } +type DiskSettingsAccessLocation struct { + // Locations: List of regions that can create a regional snapshot from + // the current region + Locations map[string]DiskSettingsAccessLocationAccessLocationPreference `json:"locations,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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 *DiskSettingsAccessLocation) MarshalJSON() ([]byte, error) { + type NoMethod DiskSettingsAccessLocation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DiskSettingsAccessLocationAccessLocationPreference: A structure for +// specifying an allowed target region to create snapshot. +type DiskSettingsAccessLocationAccessLocationPreference struct { + // Region: Accessible region name + Region string `json:"region,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Region") 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. "Region") 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 *DiskSettingsAccessLocationAccessLocationPreference) MarshalJSON() ([]byte, error) { + type NoMethod DiskSettingsAccessLocationAccessLocationPreference + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // DiskSettingsResourcePolicyDetails: This is the object for storing the // detail information about the Resource Policy that will be set as // default ones for the Disks that is using the DiskSettings. It @@ -16030,6 +16099,14 @@ type FutureReservation struct { // ShareSettings: List of Projects/Folders to share with. ShareSettings *ShareSettings `json:"shareSettings,omitempty"` + // SpecificReservationRequired: Indicates whether the auto-created + // reservation can be consumed by VMs with affinity for "any" + // reservation. If the field is set, then only VMs that target the + // reservation by name can consume from the delivered reservation. If + // set to true,the delivered resevervation will have the same name as + // the future reservation. + SpecificReservationRequired bool `json:"specificReservationRequired,omitempty"` + // SpecificSkuProperties: Future Reservation configuration to indicate // instance properties and total count. SpecificSkuProperties *FutureReservationSpecificSKUProperties `json:"specificSkuProperties,omitempty"` @@ -23327,6 +23404,10 @@ type InstanceGroupManagerInstanceFlexibilityPolicy struct { // that the group will use when creating new VMs. InstanceSelections map[string]InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection `json:"instanceSelections,omitempty"` + // ProvisioningModelMix: Provisioning model configuration used by this + // managed instance group to create instances. + ProvisioningModelMix *InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix `json:"provisioningModelMix,omitempty"` + // ForceSendFields is a list of field names (e.g. // "InstanceSelectionLists") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API @@ -23386,6 +23467,45 @@ func (s *InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection) Marshal return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix struct { + // StandardCapacityBase: The base capacity that will always use Standard + // VMs to avoid risk of more preemption than the minimum capacity user + // needs. MIG will create only Standard VMs until it reaches + // standard_capacity_base and only then will start using + // standard_capacity_percent_above_base to mix Spot with Standard VMs. + StandardCapacityBase int64 `json:"standardCapacityBase,omitempty"` + + // StandardCapacityPercentAboveBase: The percentage of target capacity + // that should use Standard VM. The remaining percentage will use Spot + // VMs. The percentage applies only to the capacity above + // standard_capacity_base. + StandardCapacityPercentAboveBase int64 `json:"standardCapacityPercentAboveBase,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "StandardCapacityBase") 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. "StandardCapacityBase") 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 *InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix) MarshalJSON() ([]byte, error) { + type NoMethod InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + type InstanceGroupManagerInstanceLifecyclePolicy struct { // DefaultActionOnFailure: The action that a MIG performs on a failed or // an unhealthy VM. A VM is marked as unhealthy when the application @@ -35159,6 +35279,15 @@ type ManagedInstancePropertiesFromFlexibilityPolicy struct { // MachineType: The machine type to be used for this instance. MachineType string `json:"machineType,omitempty"` + // ProvisioningModel: The provisioning model to be used for this + // instance. + // + // Possible values: + // "SPOT" - Heavily discounted, no guaranteed runtime. + // "STANDARD" - Standard provisioning with user controlled runtime, no + // discounts. + ProvisioningModel string `json:"provisioningModel,omitempty"` + // ForceSendFields is a list of field names (e.g. "MachineType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -45410,6 +45539,18 @@ func (s *Principal) MarshalJSON() ([]byte, error) { // resources in a Google Cloud Platform environment. For more // information, read about the Resource Hierarchy. type Project struct { + // CloudArmorTier: [Output Only] The Cloud Armor tier for this project. + // It can be one of the following values: CA_STANDARD, + // CA_ENTERPRISE_PAYGO. If this field is not specified, it is assumed to + // be CA_STANDARD. + // + // Possible values: + // "CA_ENTERPRISE_ANNUAL" - Enterprise tier protection billed + // annually. + // "CA_ENTERPRISE_PAYGO" - Enterprise tier protection billed monthly. + // "CA_STANDARD" - Standard protection. + CloudArmorTier string `json:"cloudArmorTier,omitempty"` + // CommonInstanceMetadata: Metadata key/value pairs available to all // instances contained in this project. See Custom metadata for more // information. @@ -45504,19 +45645,18 @@ type Project struct { // server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. - // "CommonInstanceMetadata") 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. "CloudArmorTier") 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. "CommonInstanceMetadata") - // 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 + // NullFields is a list of field names (e.g. "CloudArmorTier") 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. @@ -45665,6 +45805,40 @@ func (s *ProjectsListXpnHostsRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type ProjectsSetCloudArmorTierRequest struct { + // CloudArmorTier: Managed protection tier to be set. + // + // Possible values: + // "CA_ENTERPRISE_ANNUAL" - Enterprise tier protection billed + // annually. + // "CA_ENTERPRISE_PAYGO" - Enterprise tier protection billed monthly. + // "CA_STANDARD" - Standard protection. + CloudArmorTier string `json:"cloudArmorTier,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CloudArmorTier") 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. "CloudArmorTier") 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 *ProjectsSetCloudArmorTierRequest) MarshalJSON() ([]byte, error) { + type NoMethod ProjectsSetCloudArmorTierRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + type ProjectsSetDefaultNetworkTierRequest struct { // NetworkTier: Default network tier to be set. // @@ -56913,6 +57087,8 @@ type Scheduling struct { // restarted outside the window of maintenance events. OnHostMaintenance string `json:"onHostMaintenance,omitempty"` + OnInstanceStopAction *SchedulingOnInstanceStopAction `json:"onInstanceStopAction,omitempty"` + // Preemptible: Defines whether the instance is preemptible. This can // only be set during instance creation or while the instance is stopped // and therefore, in a `TERMINATED` state. See Instance Life Cycle for @@ -57031,6 +57207,39 @@ func (s *SchedulingNodeAffinity) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SchedulingOnInstanceStopAction: Defines the behaviour for instances +// with the instance_termination_action STOP. +type SchedulingOnInstanceStopAction struct { + // DiscardLocalSsd: If true, the contents of any attached Local SSD + // disks will be discarded else, the Local SSD data will be preserved + // when the instance is stopped at the end of the run + // duration/termination time. + DiscardLocalSsd bool `json:"discardLocalSsd,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DiscardLocalSsd") 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. "DiscardLocalSsd") 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 *SchedulingOnInstanceStopAction) MarshalJSON() ([]byte, error) { + type NoMethod SchedulingOnInstanceStopAction + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Screenshot: An instance's screenshot. type Screenshot struct { // Contents: [Output Only] The Base64-encoded screenshot data. @@ -64501,6 +64710,8 @@ type StoragePoolDisk struct { // "FAILED" - Disk creation failed. // "READY" - Disk is ready for use. // "RESTORING" - Source data is being copied into the disk. + // "UNAVAILABLE" - Disk is currently unavailable and cannot be + // accessed, attached or detached. Status string `json:"status,omitempty"` // Type: [Output Only] The disk type. @@ -76931,7 +77142,9 @@ type AcceleratorTypesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of accelerator types. +// AggregatedList: Retrieves an aggregated list of accelerator types. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *AcceleratorTypesService) AggregatedList(project string) *AcceleratorTypesAggregatedListCall { @@ -77029,7 +77242,9 @@ func (c *AcceleratorTypesAggregatedListCall) PageToken(pageToken string) *Accele // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *AcceleratorTypesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *AcceleratorTypesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -77143,7 +77358,7 @@ func (c *AcceleratorTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves an aggregated list of accelerator types.", + // "description": "Retrieves an aggregated list of accelerator types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/acceleratorTypes", // "httpMethod": "GET", // "id": "compute.acceleratorTypes.aggregatedList", @@ -77187,7 +77402,7 @@ func (c *AcceleratorTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -77504,7 +77719,9 @@ func (c *AcceleratorTypesListCall) PageToken(pageToken string) *AcceleratorTypes // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *AcceleratorTypesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *AcceleratorTypesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -77650,7 +77867,7 @@ func (c *AcceleratorTypesListCall) Do(opts ...googleapi.CallOption) (*Accelerato // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -77707,7 +77924,9 @@ type AddressesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of addresses. +// AggregatedList: Retrieves an aggregated list of addresses. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Project ID for this request. func (r *AddressesService) AggregatedList(project string) *AddressesAggregatedListCall { @@ -77805,7 +78024,9 @@ func (c *AddressesAggregatedListCall) PageToken(pageToken string) *AddressesAggr // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *AddressesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *AddressesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -77919,7 +78140,7 @@ func (c *AddressesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Address } return ret, nil // { - // "description": "Retrieves an aggregated list of addresses.", + // "description": "Retrieves an aggregated list of addresses. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/addresses", // "httpMethod": "GET", // "id": "compute.addresses.aggregatedList", @@ -77963,7 +78184,7 @@ func (c *AddressesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Address // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -78635,7 +78856,9 @@ func (c *AddressesListCall) PageToken(pageToken string) *AddressesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *AddressesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *AddressesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -78788,7 +79011,7 @@ func (c *AddressesListCall) Do(opts ...googleapi.CallOption) (*AddressList, erro // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -79384,7 +79607,9 @@ type AutoscalersAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of autoscalers. +// AggregatedList: Retrieves an aggregated list of autoscalers. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *AutoscalersService) AggregatedList(project string) *AutoscalersAggregatedListCall { @@ -79482,7 +79707,9 @@ func (c *AutoscalersAggregatedListCall) PageToken(pageToken string) *Autoscalers // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *AutoscalersAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *AutoscalersAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -79596,7 +79823,7 @@ func (c *AutoscalersAggregatedListCall) Do(opts ...googleapi.CallOption) (*Autos } return ret, nil // { - // "description": "Retrieves an aggregated list of autoscalers.", + // "description": "Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/autoscalers", // "httpMethod": "GET", // "id": "compute.autoscalers.aggregatedList", @@ -79640,7 +79867,7 @@ func (c *AutoscalersAggregatedListCall) Do(opts ...googleapi.CallOption) (*Autos // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -80312,7 +80539,9 @@ func (c *AutoscalersListCall) PageToken(pageToken string) *AutoscalersListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *AutoscalersListCall) ReturnPartialSuccess(returnPartialSuccess bool) *AutoscalersListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -80458,7 +80687,7 @@ func (c *AutoscalersListCall) Do(opts ...googleapi.CallOption) (*AutoscalerList, // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -82169,7 +82398,9 @@ func (c *BackendBucketsListCall) PageToken(pageToken string) *BackendBucketsList // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *BackendBucketsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *BackendBucketsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -82313,7 +82544,7 @@ func (c *BackendBucketsListCall) Do(opts ...googleapi.CallOption) (*BackendBucke // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -83386,7 +83617,9 @@ type BackendServicesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all BackendService resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *BackendServicesService) AggregatedList(project string) *BackendServicesAggregatedListCall { @@ -83484,7 +83717,9 @@ func (c *BackendServicesAggregatedListCall) PageToken(pageToken string) *Backend // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *BackendServicesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *BackendServicesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -83598,7 +83833,7 @@ func (c *BackendServicesAggregatedListCall) Do(opts ...googleapi.CallOption) (*B } return ret, nil // { - // "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/backendServices", // "httpMethod": "GET", // "id": "compute.backendServices.aggregatedList", @@ -83642,7 +83877,7 @@ func (c *BackendServicesAggregatedListCall) Do(opts ...googleapi.CallOption) (*B // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -84784,7 +85019,9 @@ func (c *BackendServicesListCall) PageToken(pageToken string) *BackendServicesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *BackendServicesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *BackendServicesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -84928,7 +85165,7 @@ func (c *BackendServicesListCall) Do(opts ...googleapi.CallOption) (*BackendServ // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -85064,7 +85301,9 @@ func (c *BackendServicesListUsableCall) PageToken(pageToken string) *BackendServ // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *BackendServicesListUsableCall) ReturnPartialSuccess(returnPartialSuccess bool) *BackendServicesListUsableCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -85208,7 +85447,7 @@ func (c *BackendServicesListUsableCall) Do(opts ...googleapi.CallOption) (*Backe // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -86633,7 +86872,9 @@ type DiskTypesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of disk types. +// AggregatedList: Retrieves an aggregated list of disk types. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *DiskTypesService) AggregatedList(project string) *DiskTypesAggregatedListCall { @@ -86731,7 +86972,9 @@ func (c *DiskTypesAggregatedListCall) PageToken(pageToken string) *DiskTypesAggr // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *DiskTypesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *DiskTypesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -86845,7 +87088,7 @@ func (c *DiskTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (*DiskTyp } return ret, nil // { - // "description": "Retrieves an aggregated list of disk types.", + // "description": "Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/diskTypes", // "httpMethod": "GET", // "id": "compute.diskTypes.aggregatedList", @@ -86889,7 +87132,7 @@ func (c *DiskTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (*DiskTyp // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -87206,7 +87449,9 @@ func (c *DiskTypesListCall) PageToken(pageToken string) *DiskTypesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *DiskTypesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *DiskTypesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -87352,7 +87597,7 @@ func (c *DiskTypesListCall) Do(opts ...googleapi.CallOption) (*DiskTypeList, err // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -87599,7 +87844,9 @@ type DisksAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of persistent disks. +// AggregatedList: Retrieves an aggregated list of persistent disks. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *DisksService) AggregatedList(project string) *DisksAggregatedListCall { @@ -87697,7 +87944,9 @@ func (c *DisksAggregatedListCall) PageToken(pageToken string) *DisksAggregatedLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *DisksAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *DisksAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -87811,7 +88060,7 @@ func (c *DisksAggregatedListCall) Do(opts ...googleapi.CallOption) (*DiskAggrega } return ret, nil // { - // "description": "Retrieves an aggregated list of persistent disks.", + // "description": "Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/disks", // "httpMethod": "GET", // "id": "compute.disks.aggregatedList", @@ -87855,7 +88104,7 @@ func (c *DisksAggregatedListCall) Do(opts ...googleapi.CallOption) (*DiskAggrega // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -89111,7 +89360,9 @@ func (c *DisksListCall) PageToken(pageToken string) *DisksListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *DisksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *DisksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -89257,7 +89508,7 @@ func (c *DisksListCall) Do(opts ...googleapi.CallOption) (*DiskList, error) { // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -91557,7 +91808,9 @@ func (c *ExternalVpnGatewaysListCall) PageToken(pageToken string) *ExternalVpnGa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ExternalVpnGatewaysListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ExternalVpnGatewaysListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -91701,7 +91954,7 @@ func (c *ExternalVpnGatewaysListCall) Do(opts ...googleapi.CallOption) (*Externa // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -93614,7 +93867,9 @@ func (c *FirewallPoliciesListCall) ParentId(parentId string) *FirewallPoliciesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *FirewallPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *FirewallPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -93750,7 +94005,7 @@ func (c *FirewallPoliciesListCall) Do(opts ...googleapi.CallOption) (*FirewallPo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -95657,7 +95912,9 @@ func (c *FirewallsListCall) PageToken(pageToken string) *FirewallsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *FirewallsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *FirewallsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -95801,7 +96058,7 @@ func (c *FirewallsListCall) Do(opts ...googleapi.CallOption) (*FirewallList, err // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -96365,7 +96622,9 @@ type ForwardingRulesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of forwarding rules. +// AggregatedList: Retrieves an aggregated list of forwarding rules. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *ForwardingRulesService) AggregatedList(project string) *ForwardingRulesAggregatedListCall { @@ -96463,7 +96722,9 @@ func (c *ForwardingRulesAggregatedListCall) PageToken(pageToken string) *Forward // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ForwardingRulesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ForwardingRulesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -96577,7 +96838,7 @@ func (c *ForwardingRulesAggregatedListCall) Do(opts ...googleapi.CallOption) (*F } return ret, nil // { - // "description": "Retrieves an aggregated list of forwarding rules.", + // "description": "Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/forwardingRules", // "httpMethod": "GET", // "id": "compute.forwardingRules.aggregatedList", @@ -96621,7 +96882,7 @@ func (c *ForwardingRulesAggregatedListCall) Do(opts ...googleapi.CallOption) (*F // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -97293,7 +97554,9 @@ func (c *ForwardingRulesListCall) PageToken(pageToken string) *ForwardingRulesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ForwardingRulesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ForwardingRulesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -97446,7 +97709,7 @@ func (c *ForwardingRulesListCall) Do(opts ...googleapi.CallOption) (*ForwardingR // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -98236,6 +98499,8 @@ type FutureReservationsAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of future reservations. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *FutureReservationsService) AggregatedList(project string) *FutureReservationsAggregatedListCall { @@ -98333,7 +98598,9 @@ func (c *FutureReservationsAggregatedListCall) PageToken(pageToken string) *Futu // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *FutureReservationsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *FutureReservationsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -98449,7 +98716,7 @@ func (c *FutureReservationsAggregatedListCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Retrieves an aggregated list of future reservations.", + // "description": "Retrieves an aggregated list of future reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/futureReservations", // "httpMethod": "GET", // "id": "compute.futureReservations.aggregatedList", @@ -98493,7 +98760,7 @@ func (c *FutureReservationsAggregatedListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -99343,7 +99610,9 @@ func (c *FutureReservationsListCall) PageToken(pageToken string) *FutureReservat // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *FutureReservationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *FutureReservationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -99489,7 +99758,7 @@ func (c *FutureReservationsListCall) Do(opts ...googleapi.CallOption) (*FutureRe // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -100492,7 +100761,9 @@ func (c *GlobalAddressesListCall) PageToken(pageToken string) *GlobalAddressesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalAddressesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalAddressesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -100636,7 +100907,7 @@ func (c *GlobalAddressesListCall) Do(opts ...googleapi.CallOption) (*AddressList // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -101754,7 +102025,9 @@ func (c *GlobalForwardingRulesListCall) PageToken(pageToken string) *GlobalForwa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalForwardingRulesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalForwardingRulesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -101898,7 +102171,7 @@ func (c *GlobalForwardingRulesListCall) Do(opts ...googleapi.CallOption) (*Forwa // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -103551,7 +103824,9 @@ func (c *GlobalNetworkEndpointGroupsListCall) PageToken(pageToken string) *Globa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalNetworkEndpointGroupsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalNetworkEndpointGroupsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -103695,7 +103970,7 @@ func (c *GlobalNetworkEndpointGroupsListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -103835,7 +104110,9 @@ func (c *GlobalNetworkEndpointGroupsListNetworkEndpointsCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalNetworkEndpointGroupsListNetworkEndpointsCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalNetworkEndpointGroupsListNetworkEndpointsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -103976,7 +104253,7 @@ func (c *GlobalNetworkEndpointGroupsListNetworkEndpointsCall) Do(opts ...googlea // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -104026,7 +104303,9 @@ type GlobalOperationsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of all operations. +// AggregatedList: Retrieves an aggregated list of all operations. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *GlobalOperationsService) AggregatedList(project string) *GlobalOperationsAggregatedListCall { @@ -104124,7 +104403,9 @@ func (c *GlobalOperationsAggregatedListCall) PageToken(pageToken string) *Global // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalOperationsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalOperationsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -104238,7 +104519,7 @@ func (c *GlobalOperationsAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves an aggregated list of all operations.", + // "description": "Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/operations", // "httpMethod": "GET", // "id": "compute.globalOperations.aggregatedList", @@ -104282,7 +104563,7 @@ func (c *GlobalOperationsAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -104701,7 +104982,9 @@ func (c *GlobalOperationsListCall) PageToken(pageToken string) *GlobalOperations // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalOperationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -104845,7 +105128,7 @@ func (c *GlobalOperationsListCall) Do(opts ...googleapi.CallOption) (*OperationL // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -105419,7 +105702,9 @@ func (c *GlobalOrganizationOperationsListCall) ParentId(parentId string) *Global // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalOrganizationOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalOrganizationOperationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -105555,7 +105840,7 @@ func (c *GlobalOrganizationOperationsListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -106183,7 +106468,9 @@ func (c *GlobalPublicDelegatedPrefixesListCall) PageToken(pageToken string) *Glo // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *GlobalPublicDelegatedPrefixesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *GlobalPublicDelegatedPrefixesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -106327,7 +106614,7 @@ func (c *GlobalPublicDelegatedPrefixesListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -106557,7 +106844,9 @@ type HealthChecksAggregatedListCall struct { } // AggregatedList: Retrieves the list of all HealthCheck resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *HealthChecksService) AggregatedList(project string) *HealthChecksAggregatedListCall { @@ -106655,7 +106944,9 @@ func (c *HealthChecksAggregatedListCall) PageToken(pageToken string) *HealthChec // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *HealthChecksAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *HealthChecksAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -106769,7 +107060,7 @@ func (c *HealthChecksAggregatedListCall) Do(opts ...googleapi.CallOption) (*Heal } return ret, nil // { - // "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/healthChecks", // "httpMethod": "GET", // "id": "compute.healthChecks.aggregatedList", @@ -106813,7 +107104,7 @@ func (c *HealthChecksAggregatedListCall) Do(opts ...googleapi.CallOption) (*Heal // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -107446,7 +107737,9 @@ func (c *HealthChecksListCall) PageToken(pageToken string) *HealthChecksListCall // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *HealthChecksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *HealthChecksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -107590,7 +107883,7 @@ func (c *HealthChecksListCall) Do(opts ...googleapi.CallOption) (*HealthCheckLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -108729,7 +109022,9 @@ func (c *HttpHealthChecksListCall) PageToken(pageToken string) *HttpHealthChecks // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *HttpHealthChecksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *HttpHealthChecksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -108873,7 +109168,7 @@ func (c *HttpHealthChecksListCall) Do(opts ...googleapi.CallOption) (*HttpHealth // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -110012,7 +110307,9 @@ func (c *HttpsHealthChecksListCall) PageToken(pageToken string) *HttpsHealthChec // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *HttpsHealthChecksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *HttpsHealthChecksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -110156,7 +110453,7 @@ func (c *HttpsHealthChecksListCall) Do(opts ...googleapi.CallOption) (*HttpsHeal // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -112002,7 +112299,9 @@ func (c *ImagesListCall) PageToken(pageToken string) *ImagesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ImagesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ImagesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -112152,7 +112451,7 @@ func (c *ImagesListCall) Do(opts ...googleapi.CallOption) (*ImageList, error) { // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -113711,7 +114010,9 @@ func (c *InstanceGroupManagerResizeRequestsListCall) PageToken(pageToken string) // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupManagerResizeRequestsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupManagerResizeRequestsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -113867,7 +114168,7 @@ func (c *InstanceGroupManagerResizeRequestsListCall) Do(opts ...googleapi.CallOp // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -114123,7 +114424,8 @@ type InstanceGroupManagersAggregatedListCall struct { } // AggregatedList: Retrieves the list of managed instance groups and -// groups them by zone. +// groups them by zone. To prevent failure, Google recommends that you +// set the `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *InstanceGroupManagersService) AggregatedList(project string) *InstanceGroupManagersAggregatedListCall { @@ -114221,7 +114523,9 @@ func (c *InstanceGroupManagersAggregatedListCall) PageToken(pageToken string) *I // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupManagersAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupManagersAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -114336,7 +114640,7 @@ func (c *InstanceGroupManagersAggregatedListCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "Retrieves the list of managed instance groups and groups them by zone.", + // "description": "Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/instanceGroupManagers", // "httpMethod": "GET", // "id": "compute.instanceGroupManagers.aggregatedList", @@ -114380,7 +114684,7 @@ func (c *InstanceGroupManagersAggregatedListCall) Do(opts ...googleapi.CallOptio // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -115790,7 +116094,9 @@ func (c *InstanceGroupManagersListCall) PageToken(pageToken string) *InstanceGro // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupManagersListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupManagersListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -115936,7 +116242,7 @@ func (c *InstanceGroupManagersListCall) Do(opts ...googleapi.CallOption) (*Insta // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -116089,7 +116395,9 @@ func (c *InstanceGroupManagersListErrorsCall) PageToken(pageToken string) *Insta // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupManagersListErrorsCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupManagersListErrorsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -116244,7 +116552,7 @@ func (c *InstanceGroupManagersListErrorsCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -116399,7 +116707,9 @@ func (c *InstanceGroupManagersListManagedInstancesCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupManagersListManagedInstancesCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupManagersListManagedInstancesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -116542,7 +116852,7 @@ func (c *InstanceGroupManagersListManagedInstancesCall) Do(opts ...googleapi.Cal // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -116692,7 +117002,9 @@ func (c *InstanceGroupManagersListPerInstanceConfigsCall) PageToken(pageToken st // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupManagersListPerInstanceConfigsCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupManagersListPerInstanceConfigsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -116837,7 +117149,7 @@ func (c *InstanceGroupManagersListPerInstanceConfigsCall) Do(opts ...googleapi.C // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -120014,7 +120326,8 @@ type InstanceGroupsAggregatedListCall struct { } // AggregatedList: Retrieves the list of instance groups and sorts them -// by zone. +// by zone. To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *InstanceGroupsService) AggregatedList(project string) *InstanceGroupsAggregatedListCall { @@ -120112,7 +120425,9 @@ func (c *InstanceGroupsAggregatedListCall) PageToken(pageToken string) *Instance // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -120226,7 +120541,7 @@ func (c *InstanceGroupsAggregatedListCall) Do(opts ...googleapi.CallOption) (*In } return ret, nil // { - // "description": "Retrieves the list of instance groups and sorts them by zone.", + // "description": "Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/instanceGroups", // "httpMethod": "GET", // "id": "compute.instanceGroups.aggregatedList", @@ -120270,7 +120585,7 @@ func (c *InstanceGroupsAggregatedListCall) Do(opts ...googleapi.CallOption) (*In // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -120945,7 +121260,9 @@ func (c *InstanceGroupsListCall) PageToken(pageToken string) *InstanceGroupsList // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -121091,7 +121408,7 @@ func (c *InstanceGroupsListCall) Do(opts ...googleapi.CallOption) (*InstanceGrou // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -121243,7 +121560,9 @@ func (c *InstanceGroupsListInstancesCall) PageToken(pageToken string) *InstanceG // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceGroupsListInstancesCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceGroupsListInstancesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -121389,7 +121708,7 @@ func (c *InstanceGroupsListInstancesCall) Do(opts ...googleapi.CallOption) (*Ins // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -122345,6 +122664,8 @@ type InstanceTemplatesAggregatedListCall struct { // AggregatedList: Retrieves the list of all InstanceTemplates // resources, regional and global, available to the specified project. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Name of the project scoping this request. func (r *InstanceTemplatesService) AggregatedList(project string) *InstanceTemplatesAggregatedListCall { @@ -122442,7 +122763,9 @@ func (c *InstanceTemplatesAggregatedListCall) PageToken(pageToken string) *Insta // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceTemplatesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceTemplatesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -122556,7 +122879,7 @@ func (c *InstanceTemplatesAggregatedListCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/instanceTemplates", // "httpMethod": "GET", // "id": "compute.instanceTemplates.aggregatedList", @@ -122600,7 +122923,7 @@ func (c *InstanceTemplatesAggregatedListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -123442,7 +123765,9 @@ func (c *InstanceTemplatesListCall) PageToken(pageToken string) *InstanceTemplat // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstanceTemplatesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstanceTemplatesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -123601,7 +123926,7 @@ func (c *InstanceTemplatesListCall) Do(opts ...googleapi.CallOption) (*InstanceT // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -124559,7 +124884,8 @@ type InstancesAggregatedListCall struct { // AggregatedList: Retrieves an aggregated list of all of the instances // in your project across all regions and zones. The performance of this // method degrades when a filter is specified on a project that has a -// very large number of instances. +// very large number of instances. To prevent failure, Google recommends +// that you set the `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *InstancesService) AggregatedList(project string) *InstancesAggregatedListCall { @@ -124657,7 +124983,9 @@ func (c *InstancesAggregatedListCall) PageToken(pageToken string) *InstancesAggr // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstancesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstancesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -124771,7 +125099,7 @@ func (c *InstancesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Instanc } return ret, nil // { - // "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.", + // "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/instances", // "httpMethod": "GET", // "id": "compute.instances.aggregatedList", @@ -124815,7 +125143,7 @@ func (c *InstancesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Instanc // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -128009,7 +128337,9 @@ func (c *InstancesListCall) PageToken(pageToken string) *InstancesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstancesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstancesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -128169,7 +128499,7 @@ func (c *InstancesListCall) Do(opts ...googleapi.CallOption) (*InstanceList, err // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -128337,7 +128667,9 @@ func (c *InstancesListReferrersCall) PageToken(pageToken string) *InstancesListR // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstancesListReferrersCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstancesListReferrersCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -128492,7 +128824,7 @@ func (c *InstancesListReferrersCall) Do(opts ...googleapi.CallOption) (*Instance // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -134829,7 +135161,9 @@ type InstantSnapshotsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of instantSnapshots. +// AggregatedList: Retrieves an aggregated list of instantSnapshots. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *InstantSnapshotsService) AggregatedList(project string) *InstantSnapshotsAggregatedListCall { @@ -134927,7 +135261,9 @@ func (c *InstantSnapshotsAggregatedListCall) PageToken(pageToken string) *Instan // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstantSnapshotsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstantSnapshotsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -135041,7 +135377,7 @@ func (c *InstantSnapshotsAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves an aggregated list of instantSnapshots.", + // "description": "Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/instantSnapshots", // "httpMethod": "GET", // "id": "compute.instantSnapshots.aggregatedList", @@ -135085,7 +135421,7 @@ func (c *InstantSnapshotsAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -135948,7 +136284,9 @@ func (c *InstantSnapshotsListCall) PageToken(pageToken string) *InstantSnapshots // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InstantSnapshotsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InstantSnapshotsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -136094,7 +136432,7 @@ func (c *InstantSnapshotsListCall) Do(opts ...googleapi.CallOption) (*InstantSna // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -136678,7 +137016,8 @@ type InterconnectAttachmentsAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of interconnect -// attachments. +// attachments. To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *InterconnectAttachmentsService) AggregatedList(project string) *InterconnectAttachmentsAggregatedListCall { @@ -136776,7 +137115,9 @@ func (c *InterconnectAttachmentsAggregatedListCall) PageToken(pageToken string) // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InterconnectAttachmentsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InterconnectAttachmentsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -136891,7 +137232,7 @@ func (c *InterconnectAttachmentsAggregatedListCall) Do(opts ...googleapi.CallOpt } return ret, nil // { - // "description": "Retrieves an aggregated list of interconnect attachments.", + // "description": "Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/interconnectAttachments", // "httpMethod": "GET", // "id": "compute.interconnectAttachments.aggregatedList", @@ -136935,7 +137276,7 @@ func (c *InterconnectAttachmentsAggregatedListCall) Do(opts ...googleapi.CallOpt // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -137807,7 +138148,9 @@ func (c *InterconnectAttachmentsListCall) PageToken(pageToken string) *Interconn // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InterconnectAttachmentsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InterconnectAttachmentsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -137960,7 +138303,7 @@ func (c *InterconnectAttachmentsListCall) Do(opts ...googleapi.CallOption) (*Int // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -138975,7 +139318,9 @@ func (c *InterconnectLocationsListCall) PageToken(pageToken string) *Interconnec // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InterconnectLocationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InterconnectLocationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -139119,7 +139464,7 @@ func (c *InterconnectLocationsListCall) Do(opts ...googleapi.CallOption) (*Inter // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -139575,7 +139920,9 @@ func (c *InterconnectRemoteLocationsListCall) PageToken(pageToken string) *Inter // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InterconnectRemoteLocationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InterconnectRemoteLocationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -139719,7 +140066,7 @@ func (c *InterconnectRemoteLocationsListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -141006,7 +141353,9 @@ func (c *InterconnectsListCall) PageToken(pageToken string) *InterconnectsListCa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *InterconnectsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *InterconnectsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -141150,7 +141499,7 @@ func (c *InterconnectsListCall) Do(opts ...googleapi.CallOption) (*InterconnectL // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -143270,7 +143619,9 @@ func (c *LicensesListCall) PageToken(pageToken string) *LicensesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *LicensesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *LicensesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -143414,7 +143765,7 @@ func (c *LicensesListCall) Do(opts ...googleapi.CallOption) (*LicensesListRespon // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -144548,7 +144899,9 @@ func (c *MachineImagesListCall) PageToken(pageToken string) *MachineImagesListCa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *MachineImagesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *MachineImagesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -144692,7 +145045,7 @@ func (c *MachineImagesListCall) Do(opts ...googleapi.CallOption) (*MachineImageL // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -145055,7 +145408,9 @@ type MachineTypesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of machine types. +// AggregatedList: Retrieves an aggregated list of machine types. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *MachineTypesService) AggregatedList(project string) *MachineTypesAggregatedListCall { @@ -145153,7 +145508,9 @@ func (c *MachineTypesAggregatedListCall) PageToken(pageToken string) *MachineTyp // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *MachineTypesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *MachineTypesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -145267,7 +145624,7 @@ func (c *MachineTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Mach } return ret, nil // { - // "description": "Retrieves an aggregated list of machine types.", + // "description": "Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/machineTypes", // "httpMethod": "GET", // "id": "compute.machineTypes.aggregatedList", @@ -145311,7 +145668,7 @@ func (c *MachineTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Mach // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -145628,7 +145985,9 @@ func (c *MachineTypesListCall) PageToken(pageToken string) *MachineTypesListCall // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *MachineTypesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *MachineTypesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -145774,7 +146133,7 @@ func (c *MachineTypesListCall) Do(opts ...googleapi.CallOption) (*MachineTypeLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -145833,6 +146192,8 @@ type NetworkAttachmentsAggregatedListCall struct { // AggregatedList: Retrieves the list of all NetworkAttachment // resources, regional and global, available to the specified project. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *NetworkAttachmentsService) AggregatedList(project string) *NetworkAttachmentsAggregatedListCall { @@ -145930,7 +146291,9 @@ func (c *NetworkAttachmentsAggregatedListCall) PageToken(pageToken string) *Netw // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkAttachmentsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkAttachmentsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -146044,7 +146407,7 @@ func (c *NetworkAttachmentsAggregatedListCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/networkAttachments", // "httpMethod": "GET", // "id": "compute.networkAttachments.aggregatedList", @@ -146088,7 +146451,7 @@ func (c *NetworkAttachmentsAggregatedListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -146950,7 +147313,9 @@ func (c *NetworkAttachmentsListCall) PageToken(pageToken string) *NetworkAttachm // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkAttachmentsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkAttachmentsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -147103,7 +147468,7 @@ func (c *NetworkAttachmentsListCall) Do(opts ...googleapi.CallOption) (*NetworkA // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -147682,7 +148047,9 @@ type NetworkEdgeSecurityServicesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all NetworkEdgeSecurityService -// resources available to the specified project. +// resources available to the specified project. To prevent failure, +// Google recommends that you set the `returnPartialSuccess` parameter +// to `true`. // // - project: Name of the project scoping this request. func (r *NetworkEdgeSecurityServicesService) AggregatedList(project string) *NetworkEdgeSecurityServicesAggregatedListCall { @@ -147780,7 +148147,9 @@ func (c *NetworkEdgeSecurityServicesAggregatedListCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkEdgeSecurityServicesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkEdgeSecurityServicesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -147896,7 +148265,7 @@ func (c *NetworkEdgeSecurityServicesAggregatedListCall) Do(opts ...googleapi.Cal } return ret, nil // { - // "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.", + // "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices", // "httpMethod": "GET", // "id": "compute.networkEdgeSecurityServices.aggregatedList", @@ -147940,7 +148309,7 @@ func (c *NetworkEdgeSecurityServicesAggregatedListCall) Do(opts ...googleapi.Cal // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -148752,7 +149121,8 @@ type NetworkEndpointGroupsAggregatedListCall struct { } // AggregatedList: Retrieves the list of network endpoint groups and -// sorts them by zone. +// sorts them by zone. To prevent failure, Google recommends that you +// set the `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *NetworkEndpointGroupsService) AggregatedList(project string) *NetworkEndpointGroupsAggregatedListCall { @@ -148850,7 +149220,9 @@ func (c *NetworkEndpointGroupsAggregatedListCall) PageToken(pageToken string) *N // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkEndpointGroupsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkEndpointGroupsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -148965,7 +149337,7 @@ func (c *NetworkEndpointGroupsAggregatedListCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "Retrieves the list of network endpoint groups and sorts them by zone.", + // "description": "Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/networkEndpointGroups", // "httpMethod": "GET", // "id": "compute.networkEndpointGroups.aggregatedList", @@ -149009,7 +149381,7 @@ func (c *NetworkEndpointGroupsAggregatedListCall) Do(opts ...googleapi.CallOptio // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -150064,7 +150436,9 @@ func (c *NetworkEndpointGroupsListCall) PageToken(pageToken string) *NetworkEndp // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkEndpointGroupsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkEndpointGroupsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -150210,7 +150584,7 @@ func (c *NetworkEndpointGroupsListCall) Do(opts ...googleapi.CallOption) (*Netwo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -150362,7 +150736,9 @@ func (c *NetworkEndpointGroupsListNetworkEndpointsCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkEndpointGroupsListNetworkEndpointsCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkEndpointGroupsListNetworkEndpointsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -150510,7 +150886,7 @@ func (c *NetworkEndpointGroupsListNetworkEndpointsCall) Do(opts ...googleapi.Cal // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -152427,7 +152803,9 @@ func (c *NetworkFirewallPoliciesListCall) PageToken(pageToken string) *NetworkFi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworkFirewallPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworkFirewallPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -152571,7 +152949,7 @@ func (c *NetworkFirewallPoliciesListCall) Do(opts ...googleapi.CallOption) (*Fir // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -154750,7 +155128,9 @@ func (c *NetworksListCall) PageToken(pageToken string) *NetworksListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -154894,7 +155274,7 @@ func (c *NetworksListCall) Do(opts ...googleapi.CallOption) (*NetworkList, error // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -155033,7 +155413,9 @@ func (c *NetworksListIpAddressesCall) PageToken(pageToken string) *NetworksListI // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworksListIpAddressesCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworksListIpAddressesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -155194,7 +155576,7 @@ func (c *NetworksListIpAddressesCall) Do(opts ...googleapi.CallOption) (*IpAddre // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -155358,7 +155740,9 @@ func (c *NetworksListIpOwnersCall) PageToken(pageToken string) *NetworksListIpOw // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworksListIpOwnersCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworksListIpOwnersCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -155540,7 +155924,7 @@ func (c *NetworksListIpOwnersCall) Do(opts ...googleapi.CallOption) (*IpOwnerLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -155718,7 +156102,9 @@ func (c *NetworksListPeeringRoutesCall) Region(region string) *NetworksListPeeri // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NetworksListPeeringRoutesCall) ReturnPartialSuccess(returnPartialSuccess bool) *NetworksListPeeringRoutesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -155894,7 +156280,7 @@ func (c *NetworksListPeeringRoutesCall) Do(opts ...googleapi.CallOption) (*Excha // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -156991,7 +157377,9 @@ type NodeGroupsAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of node groups. Note: -// use nodeGroups.listNodes for more details about each group. +// use nodeGroups.listNodes for more details about each group. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *NodeGroupsService) AggregatedList(project string) *NodeGroupsAggregatedListCall { @@ -157089,7 +157477,9 @@ func (c *NodeGroupsAggregatedListCall) PageToken(pageToken string) *NodeGroupsAg // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeGroupsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeGroupsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -157203,7 +157593,7 @@ func (c *NodeGroupsAggregatedListCall) Do(opts ...googleapi.CallOption) (*NodeGr } return ret, nil // { - // "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.", + // "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/nodeGroups", // "httpMethod": "GET", // "id": "compute.nodeGroups.aggregatedList", @@ -157247,7 +157637,7 @@ func (c *NodeGroupsAggregatedListCall) Do(opts ...googleapi.CallOption) (*NodeGr // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -158307,7 +158697,9 @@ func (c *NodeGroupsListCall) PageToken(pageToken string) *NodeGroupsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeGroupsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeGroupsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -158453,7 +158845,7 @@ func (c *NodeGroupsListCall) Do(opts ...googleapi.CallOption) (*NodeGroupList, e // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -158601,7 +158993,9 @@ func (c *NodeGroupsListNodesCall) PageToken(pageToken string) *NodeGroupsListNod // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeGroupsListNodesCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeGroupsListNodesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -158743,7 +159137,7 @@ func (c *NodeGroupsListNodesCall) Do(opts ...googleapi.CallOption) (*NodeGroupsL // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -159892,7 +160286,9 @@ type NodeTemplatesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of node templates. +// AggregatedList: Retrieves an aggregated list of node templates. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *NodeTemplatesService) AggregatedList(project string) *NodeTemplatesAggregatedListCall { @@ -159990,7 +160386,9 @@ func (c *NodeTemplatesAggregatedListCall) PageToken(pageToken string) *NodeTempl // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeTemplatesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeTemplatesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -160104,7 +160502,7 @@ func (c *NodeTemplatesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Nod } return ret, nil // { - // "description": "Retrieves an aggregated list of node templates.", + // "description": "Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/nodeTemplates", // "httpMethod": "GET", // "id": "compute.nodeTemplates.aggregatedList", @@ -160148,7 +160546,7 @@ func (c *NodeTemplatesAggregatedListCall) Do(opts ...googleapi.CallOption) (*Nod // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -161006,7 +161404,9 @@ func (c *NodeTemplatesListCall) PageToken(pageToken string) *NodeTemplatesListCa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeTemplatesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeTemplatesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -161159,7 +161559,7 @@ func (c *NodeTemplatesListCall) Do(opts ...googleapi.CallOption) (*NodeTemplateL // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -161546,7 +161946,9 @@ type NodeTypesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of node types. +// AggregatedList: Retrieves an aggregated list of node types. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *NodeTypesService) AggregatedList(project string) *NodeTypesAggregatedListCall { @@ -161644,7 +162046,9 @@ func (c *NodeTypesAggregatedListCall) PageToken(pageToken string) *NodeTypesAggr // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeTypesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeTypesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -161758,7 +162162,7 @@ func (c *NodeTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (*NodeTyp } return ret, nil // { - // "description": "Retrieves an aggregated list of node types.", + // "description": "Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/nodeTypes", // "httpMethod": "GET", // "id": "compute.nodeTypes.aggregatedList", @@ -161802,7 +162206,7 @@ func (c *NodeTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (*NodeTyp // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -162119,7 +162523,9 @@ func (c *NodeTypesListCall) PageToken(pageToken string) *NodeTypesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *NodeTypesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *NodeTypesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -162265,7 +162671,7 @@ func (c *NodeTypesListCall) Do(opts ...googleapi.CallOption) (*NodeTypeList, err // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -163709,7 +164115,9 @@ func (c *OrganizationSecurityPoliciesListCall) ParentId(parentId string) *Organi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *OrganizationSecurityPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *OrganizationSecurityPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -163845,7 +164253,7 @@ func (c *OrganizationSecurityPoliciesListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -164884,7 +165292,9 @@ type PacketMirroringsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of packetMirrorings. +// AggregatedList: Retrieves an aggregated list of packetMirrorings. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *PacketMirroringsService) AggregatedList(project string) *PacketMirroringsAggregatedListCall { @@ -164982,7 +165392,9 @@ func (c *PacketMirroringsAggregatedListCall) PageToken(pageToken string) *Packet // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *PacketMirroringsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *PacketMirroringsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -165096,7 +165508,7 @@ func (c *PacketMirroringsAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves an aggregated list of packetMirrorings.", + // "description": "Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/packetMirrorings", // "httpMethod": "GET", // "id": "compute.packetMirrorings.aggregatedList", @@ -165140,7 +165552,7 @@ func (c *PacketMirroringsAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -165812,7 +166224,9 @@ func (c *PacketMirroringsListCall) PageToken(pageToken string) *PacketMirrorings // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *PacketMirroringsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *PacketMirroringsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -165965,7 +166379,7 @@ func (c *PacketMirroringsListCall) Do(opts ...googleapi.CallOption) (*PacketMirr // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -167402,7 +167816,9 @@ func (c *ProjectsGetXpnResourcesCall) PageToken(pageToken string) *ProjectsGetXp // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ProjectsGetXpnResourcesCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsGetXpnResourcesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -167546,7 +167962,7 @@ func (c *ProjectsGetXpnResourcesCall) Do(opts ...googleapi.CallOption) (*Project // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -167682,7 +168098,9 @@ func (c *ProjectsListXpnHostsCall) PageToken(pageToken string) *ProjectsListXpnH // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ProjectsListXpnHostsCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsListXpnHostsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -167818,7 +168236,7 @@ func (c *ProjectsListXpnHostsCall) Do(opts ...googleapi.CallOption) (*XpnHostLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -168195,6 +168613,173 @@ func (c *ProjectsMoveInstanceCall) Do(opts ...googleapi.CallOption) (*Operation, } +// method id "compute.projects.setCloudArmorTier": + +type ProjectsSetCloudArmorTierCall struct { + s *Service + project string + projectssetcloudarmortierrequest *ProjectsSetCloudArmorTierRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetCloudArmorTier: Sets the Cloud Armor tier of the project. To set +// ENTERPRISE or above the billing account of the project must be +// subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor +// Enterprise for more information. +// +// - project: Project ID for this request. +func (r *ProjectsService) SetCloudArmorTier(project string, projectssetcloudarmortierrequest *ProjectsSetCloudArmorTierRequest) *ProjectsSetCloudArmorTierCall { + c := &ProjectsSetCloudArmorTierCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.project = project + c.projectssetcloudarmortierrequest = projectssetcloudarmortierrequest + return c +} + +// RequestId sets the optional parameter "requestId": An optional +// request ID to identify requests. Specify a unique request ID so that +// if you must retry your request, the server will know to ignore the +// request if it has already been completed. For example, consider a +// situation where you make an initial request and the request times +// out. If you make the request again with the same request ID, the +// server can check if original operation with the same request ID was +// received, and if so, will ignore the second request. This prevents +// clients from accidentally creating duplicate commitments. The request +// ID must be a valid UUID with the exception that zero UUID is not +// supported ( 00000000-0000-0000-0000-000000000000). +func (c *ProjectsSetCloudArmorTierCall) RequestId(requestId string) *ProjectsSetCloudArmorTierCall { + c.urlParams_.Set("requestId", requestId) + 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 *ProjectsSetCloudArmorTierCall) Fields(s ...googleapi.Field) *ProjectsSetCloudArmorTierCall { + 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 *ProjectsSetCloudArmorTierCall) Context(ctx context.Context) *ProjectsSetCloudArmorTierCall { + 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 *ProjectsSetCloudArmorTierCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsSetCloudArmorTierCall) 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.projectssetcloudarmortierrequest) + 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, "projects/{project}/setCloudArmorTier") + 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{ + "project": c.project, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "compute.projects.setCloudArmorTier" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.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 *ProjectsSetCloudArmorTierCall) Do(opts ...googleapi.CallOption) (*Operation, 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 := &Operation{ + 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": "Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.", + // "flatPath": "projects/{project}/setCloudArmorTier", + // "httpMethod": "POST", + // "id": "compute.projects.setCloudArmorTier", + // "parameterOrder": [ + // "project" + // ], + // "parameters": { + // "project": { + // "description": "Project ID for this request.", + // "location": "path", + // "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "projects/{project}/setCloudArmorTier", + // "request": { + // "$ref": "ProjectsSetCloudArmorTierRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/compute" + // ] + // } + +} + // method id "compute.projects.setCommonInstanceMetadata": type ProjectsSetCommonInstanceMetadataCall struct { @@ -169785,7 +170370,9 @@ func (c *PublicAdvertisedPrefixesListCall) PageToken(pageToken string) *PublicAd // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *PublicAdvertisedPrefixesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *PublicAdvertisedPrefixesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -169929,7 +170516,7 @@ func (c *PublicAdvertisedPrefixesListCall) Do(opts ...googleapi.CallOption) (*Pu // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -170325,7 +170912,9 @@ type PublicDelegatedPrefixesAggregatedListCall struct { } // AggregatedList: Lists all PublicDelegatedPrefix resources owned by -// the specific project across all scopes. +// the specific project across all scopes. To prevent failure, Google +// recommends that you set the `returnPartialSuccess` parameter to +// `true`. // // - project: Name of the project scoping this request. func (r *PublicDelegatedPrefixesService) AggregatedList(project string) *PublicDelegatedPrefixesAggregatedListCall { @@ -170423,7 +171012,9 @@ func (c *PublicDelegatedPrefixesAggregatedListCall) PageToken(pageToken string) // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *PublicDelegatedPrefixesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *PublicDelegatedPrefixesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -170538,7 +171129,7 @@ func (c *PublicDelegatedPrefixesAggregatedListCall) Do(opts ...googleapi.CallOpt } return ret, nil // { - // "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.", + // "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes", // "httpMethod": "GET", // "id": "compute.publicDelegatedPrefixes.aggregatedList", @@ -170582,7 +171173,7 @@ func (c *PublicDelegatedPrefixesAggregatedListCall) Do(opts ...googleapi.CallOpt // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -171438,7 +172029,9 @@ func (c *PublicDelegatedPrefixesListCall) PageToken(pageToken string) *PublicDel // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *PublicDelegatedPrefixesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *PublicDelegatedPrefixesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -171591,7 +172184,7 @@ func (c *PublicDelegatedPrefixesListCall) Do(opts ...googleapi.CallOption) (*Pub // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -172627,7 +173220,9 @@ func (c *RegionAutoscalersListCall) PageToken(pageToken string) *RegionAutoscale // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionAutoscalersListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionAutoscalersListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -172780,7 +173375,7 @@ func (c *RegionAutoscalersListCall) Do(opts ...googleapi.CallOption) (*RegionAut // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -174352,7 +174947,9 @@ func (c *RegionBackendServicesListCall) PageToken(pageToken string) *RegionBacke // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionBackendServicesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionBackendServicesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -174505,7 +175102,7 @@ func (c *RegionBackendServicesListCall) Do(opts ...googleapi.CallOption) (*Backe // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -174645,7 +175242,9 @@ func (c *RegionBackendServicesListUsableCall) PageToken(pageToken string) *Regio // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionBackendServicesListUsableCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionBackendServicesListUsableCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -174797,7 +175396,7 @@ func (c *RegionBackendServicesListUsableCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -175756,7 +176355,8 @@ type RegionCommitmentsAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of commitments by -// region. +// region. To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *RegionCommitmentsService) AggregatedList(project string) *RegionCommitmentsAggregatedListCall { @@ -175854,7 +176454,9 @@ func (c *RegionCommitmentsAggregatedListCall) PageToken(pageToken string) *Regio // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionCommitmentsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionCommitmentsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -175968,7 +176570,7 @@ func (c *RegionCommitmentsAggregatedListCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Retrieves an aggregated list of commitments by region.", + // "description": "Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/commitments", // "httpMethod": "GET", // "id": "compute.regionCommitments.aggregatedList", @@ -176012,7 +176614,7 @@ func (c *RegionCommitmentsAggregatedListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -176863,7 +177465,9 @@ func (c *RegionCommitmentsListCall) PageToken(pageToken string) *RegionCommitmen // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionCommitmentsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionCommitmentsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -177016,7 +177620,7 @@ func (c *RegionCommitmentsListCall) Do(opts ...googleapi.CallOption) (*Commitmen // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -178251,7 +178855,9 @@ func (c *RegionDiskTypesListCall) PageToken(pageToken string) *RegionDiskTypesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionDiskTypesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionDiskTypesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -178404,7 +179010,7 @@ func (c *RegionDiskTypesListCall) Do(opts ...googleapi.CallOption) (*RegionDiskT // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -179840,7 +180446,9 @@ func (c *RegionDisksListCall) PageToken(pageToken string) *RegionDisksListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionDisksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionDisksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -179993,7 +180601,7 @@ func (c *RegionDisksListCall) Do(opts ...googleapi.CallOption) (*DiskList, error // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -181709,6 +182317,8 @@ type RegionHealthCheckServicesAggregatedListCall struct { // AggregatedList: Retrieves the list of all HealthCheckService // resources, regional and global, available to the specified project. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Name of the project scoping this request. func (r *RegionHealthCheckServicesService) AggregatedList(project string) *RegionHealthCheckServicesAggregatedListCall { @@ -181806,7 +182416,9 @@ func (c *RegionHealthCheckServicesAggregatedListCall) PageToken(pageToken string // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionHealthCheckServicesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionHealthCheckServicesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -181920,7 +182532,7 @@ func (c *RegionHealthCheckServicesAggregatedListCall) Do(opts ...googleapi.CallO } return ret, nil // { - // "description": "Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/healthCheckServices", // "httpMethod": "GET", // "id": "compute.regionHealthCheckServices.aggregatedList", @@ -181964,7 +182576,7 @@ func (c *RegionHealthCheckServicesAggregatedListCall) Do(opts ...googleapi.CallO // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -182636,7 +183248,9 @@ func (c *RegionHealthCheckServicesListCall) PageToken(pageToken string) *RegionH // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionHealthCheckServicesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionHealthCheckServicesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -182789,7 +183403,7 @@ func (c *RegionHealthCheckServicesListCall) Do(opts ...googleapi.CallOption) (*H // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -183814,7 +184428,9 @@ func (c *RegionHealthChecksListCall) PageToken(pageToken string) *RegionHealthCh // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionHealthChecksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionHealthChecksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -183967,7 +184583,7 @@ func (c *RegionHealthChecksListCall) Do(opts ...googleapi.CallOption) (*HealthCh // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -186110,7 +186726,9 @@ func (c *RegionInstanceGroupManagersListCall) PageToken(pageToken string) *Regio // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceGroupManagersListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceGroupManagersListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -186262,7 +186880,7 @@ func (c *RegionInstanceGroupManagersListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -186409,7 +187027,9 @@ func (c *RegionInstanceGroupManagersListErrorsCall) PageToken(pageToken string) // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceGroupManagersListErrorsCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceGroupManagersListErrorsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -186571,7 +187191,7 @@ func (c *RegionInstanceGroupManagersListErrorsCall) Do(opts ...googleapi.CallOpt // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -186716,7 +187336,9 @@ func (c *RegionInstanceGroupManagersListManagedInstancesCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceGroupManagersListManagedInstancesCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceGroupManagersListManagedInstancesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -186865,7 +187487,7 @@ func (c *RegionInstanceGroupManagersListManagedInstancesCall) Do(opts ...googlea // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -187009,7 +187631,9 @@ func (c *RegionInstanceGroupManagersListPerInstanceConfigsCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceGroupManagersListPerInstanceConfigsCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceGroupManagersListPerInstanceConfigsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -187158,7 +187782,7 @@ func (c *RegionInstanceGroupManagersListPerInstanceConfigsCall) Do(opts ...googl // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -190374,7 +190998,9 @@ func (c *RegionInstanceGroupsListCall) PageToken(pageToken string) *RegionInstan // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceGroupsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceGroupsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -190526,7 +191152,7 @@ func (c *RegionInstanceGroupsListCall) Do(opts ...googleapi.CallOption) (*Region // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -190673,7 +191299,9 @@ func (c *RegionInstanceGroupsListInstancesCall) PageToken(pageToken string) *Reg // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceGroupsListInstancesCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceGroupsListInstancesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -190826,7 +191454,7 @@ func (c *RegionInstanceGroupsListInstancesCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -191884,7 +192512,9 @@ func (c *RegionInstanceTemplatesListCall) PageToken(pageToken string) *RegionIns // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstanceTemplatesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstanceTemplatesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -192052,7 +192682,7 @@ func (c *RegionInstanceTemplatesListCall) Do(opts ...googleapi.CallOption) (*Ins // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -193101,7 +193731,9 @@ func (c *RegionInstantSnapshotsListCall) PageToken(pageToken string) *RegionInst // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionInstantSnapshotsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionInstantSnapshotsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -193254,7 +193886,7 @@ func (c *RegionInstantSnapshotsListCall) Do(opts ...googleapi.CallOption) (*Inst // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -194831,7 +195463,9 @@ func (c *RegionNetworkEndpointGroupsListCall) PageToken(pageToken string) *Regio // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionNetworkEndpointGroupsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionNetworkEndpointGroupsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -194983,7 +195617,7 @@ func (c *RegionNetworkEndpointGroupsListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -195127,7 +195761,9 @@ func (c *RegionNetworkEndpointGroupsListNetworkEndpointsCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionNetworkEndpointGroupsListNetworkEndpointsCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionNetworkEndpointGroupsListNetworkEndpointsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -195276,7 +195912,7 @@ func (c *RegionNetworkEndpointGroupsListNetworkEndpointsCall) Do(opts ...googlea // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -197298,7 +197934,9 @@ func (c *RegionNetworkFirewallPoliciesListCall) PageToken(pageToken string) *Reg // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionNetworkFirewallPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionNetworkFirewallPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -197451,7 +198089,7 @@ func (c *RegionNetworkFirewallPoliciesListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -198897,7 +199535,9 @@ func (c *RegionNotificationEndpointsAggregatedListCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionNotificationEndpointsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionNotificationEndpointsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -199056,7 +199696,7 @@ func (c *RegionNotificationEndpointsAggregatedListCall) Do(opts ...googleapi.Cal // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -199732,7 +200372,9 @@ func (c *RegionNotificationEndpointsListCall) PageToken(pageToken string) *Regio // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionNotificationEndpointsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionNotificationEndpointsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -199885,7 +200527,7 @@ func (c *RegionNotificationEndpointsListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -200494,7 +201136,9 @@ func (c *RegionOperationsListCall) PageToken(pageToken string) *RegionOperations // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionOperationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -200647,7 +201291,7 @@ func (c *RegionOperationsListCall) Do(opts ...googleapi.CallOption) (*OperationL // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -201860,7 +202504,9 @@ func (c *RegionSecurityPoliciesListCall) PageToken(pageToken string) *RegionSecu // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionSecurityPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionSecurityPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -202013,7 +202659,7 @@ func (c *RegionSecurityPoliciesListCall) Do(opts ...googleapi.CallOption) (*Secu // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -203812,7 +204458,9 @@ func (c *RegionSnapshotsListCall) PageToken(pageToken string) *RegionSnapshotsLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionSnapshotsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionSnapshotsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -203965,7 +204613,7 @@ func (c *RegionSnapshotsListCall) Do(opts ...googleapi.CallOption) (*SnapshotLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -205159,7 +205807,9 @@ func (c *RegionSslCertificatesListCall) PageToken(pageToken string) *RegionSslCe // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionSslCertificatesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionSslCertificatesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -205312,7 +205962,7 @@ func (c *RegionSslCertificatesListCall) Do(opts ...googleapi.CallOption) (*SslCe // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -206150,7 +206800,9 @@ func (c *RegionSslPoliciesListCall) PageToken(pageToken string) *RegionSslPolici // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionSslPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionSslPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -206303,7 +206955,7 @@ func (c *RegionSslPoliciesListCall) Do(opts ...googleapi.CallOption) (*SslPolici // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -206442,7 +207094,9 @@ func (c *RegionSslPoliciesListAvailableFeaturesCall) PageToken(pageToken string) // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionSslPoliciesListAvailableFeaturesCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionSslPoliciesListAvailableFeaturesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -206597,7 +207251,7 @@ func (c *RegionSslPoliciesListAvailableFeaturesCall) Do(opts ...googleapi.CallOp // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -207601,7 +208255,9 @@ func (c *RegionTargetHttpProxiesListCall) PageToken(pageToken string) *RegionTar // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionTargetHttpProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionTargetHttpProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -207754,7 +208410,7 @@ func (c *RegionTargetHttpProxiesListCall) Do(opts ...googleapi.CallOption) (*Tar // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -208778,7 +209434,9 @@ func (c *RegionTargetHttpsProxiesListCall) PageToken(pageToken string) *RegionTa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionTargetHttpsProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionTargetHttpsProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -208931,7 +209589,7 @@ func (c *RegionTargetHttpsProxiesListCall) Do(opts ...googleapi.CallOption) (*Ta // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -210334,7 +210992,9 @@ func (c *RegionTargetTcpProxiesListCall) PageToken(pageToken string) *RegionTarg // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionTargetTcpProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionTargetTcpProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -210487,7 +211147,7 @@ func (c *RegionTargetTcpProxiesListCall) Do(opts ...googleapi.CallOption) (*Targ // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -211486,7 +212146,9 @@ func (c *RegionUrlMapsListCall) PageToken(pageToken string) *RegionUrlMapsListCa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionUrlMapsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionUrlMapsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -211639,7 +212301,7 @@ func (c *RegionUrlMapsListCall) Do(opts ...googleapi.CallOption) (*UrlMapList, e // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -212477,7 +213139,9 @@ func (c *RegionZonesListCall) PageToken(pageToken string) *RegionZonesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionZonesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionZonesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -212630,7 +213294,7 @@ func (c *RegionZonesListCall) Do(opts ...googleapi.CallOption) (*ZoneList, error // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -212940,7 +213604,9 @@ func (c *RegionsListCall) PageToken(pageToken string) *RegionsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RegionsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RegionsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -213084,7 +213750,7 @@ func (c *RegionsListCall) Do(opts ...googleapi.CallOption) (*RegionList, error) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -213134,7 +213800,9 @@ type ReservationsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of reservations. +// AggregatedList: Retrieves an aggregated list of reservations. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *ReservationsService) AggregatedList(project string) *ReservationsAggregatedListCall { @@ -213232,7 +213900,9 @@ func (c *ReservationsAggregatedListCall) PageToken(pageToken string) *Reservatio // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ReservationsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ReservationsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -213346,7 +214016,7 @@ func (c *ReservationsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Rese } return ret, nil // { - // "description": "Retrieves an aggregated list of reservations.", + // "description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/reservations", // "httpMethod": "GET", // "id": "compute.reservations.aggregatedList", @@ -213390,7 +214060,7 @@ func (c *ReservationsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Rese // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -214248,7 +214918,9 @@ func (c *ReservationsListCall) PageToken(pageToken string) *ReservationsListCall // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ReservationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ReservationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -214394,7 +215066,7 @@ func (c *ReservationsListCall) Do(opts ...googleapi.CallOption) (*ReservationLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -215190,7 +215862,9 @@ type ResourcePoliciesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of resource policies. +// AggregatedList: Retrieves an aggregated list of resource policies. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *ResourcePoliciesService) AggregatedList(project string) *ResourcePoliciesAggregatedListCall { @@ -215288,7 +215962,9 @@ func (c *ResourcePoliciesAggregatedListCall) PageToken(pageToken string) *Resour // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ResourcePoliciesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ResourcePoliciesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -215402,7 +216078,7 @@ func (c *ResourcePoliciesAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves an aggregated list of resource policies.", + // "description": "Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/resourcePolicies", // "httpMethod": "GET", // "id": "compute.resourcePolicies.aggregatedList", @@ -215446,7 +216122,7 @@ func (c *ResourcePoliciesAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -216303,7 +216979,9 @@ func (c *ResourcePoliciesListCall) PageToken(pageToken string) *ResourcePolicies // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ResourcePoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ResourcePoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -216456,7 +217134,7 @@ func (c *ResourcePoliciesListCall) Do(opts ...googleapi.CallOption) (*ResourcePo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -217055,7 +217733,9 @@ type RoutersAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of routers. +// AggregatedList: Retrieves an aggregated list of routers. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Project ID for this request. func (r *RoutersService) AggregatedList(project string) *RoutersAggregatedListCall { @@ -217153,7 +217833,9 @@ func (c *RoutersAggregatedListCall) PageToken(pageToken string) *RoutersAggregat // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutersAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutersAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -217267,7 +217949,7 @@ func (c *RoutersAggregatedListCall) Do(opts ...googleapi.CallOption) (*RouterAgg } return ret, nil // { - // "description": "Retrieves an aggregated list of routers.", + // "description": "Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/routers", // "httpMethod": "GET", // "id": "compute.routers.aggregatedList", @@ -217311,7 +217993,7 @@ func (c *RoutersAggregatedListCall) Do(opts ...googleapi.CallOption) (*RouterAgg // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -218568,7 +219250,9 @@ func (c *RoutersGetNatMappingInfoCall) PageToken(pageToken string) *RoutersGetNa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutersGetNatMappingInfoCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutersGetNatMappingInfoCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -218728,7 +219412,7 @@ func (c *RoutersGetNatMappingInfoCall) Do(opts ...googleapi.CallOption) (*VmEndp // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -219408,7 +220092,9 @@ func (c *RoutersListCall) PageToken(pageToken string) *RoutersListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutersListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutersListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -219561,7 +220247,7 @@ func (c *RoutersListCall) Do(opts ...googleapi.CallOption) (*RouterList, error) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -219739,7 +220425,9 @@ func (c *RoutersListBgpRoutesCall) PolicyApplied(policyApplied bool) *RoutersLis // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutersListBgpRoutesCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutersListBgpRoutesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -219939,7 +220627,7 @@ func (c *RoutersListBgpRoutesCall) Do(opts ...googleapi.CallOption) (*RoutersLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -220105,7 +220793,9 @@ func (c *RoutersListNamedSetsCall) PageToken(pageToken string) *RoutersListNamed // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutersListNamedSetsCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutersListNamedSetsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -220260,7 +220950,7 @@ func (c *RoutersListNamedSetsCall) Do(opts ...googleapi.CallOption) (*RoutersLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -220410,7 +221100,9 @@ func (c *RoutersListRoutePoliciesCall) PageToken(pageToken string) *RoutersListR // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutersListRoutePoliciesCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutersListRoutePoliciesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -220565,7 +221257,7 @@ func (c *RoutersListRoutePoliciesCall) Do(opts ...googleapi.CallOption) (*Router // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -222296,7 +222988,9 @@ func (c *RoutesListCall) PageToken(pageToken string) *RoutesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *RoutesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *RoutesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -222440,7 +223134,7 @@ func (c *RoutesListCall) Do(opts ...googleapi.CallOption) (*RouteList, error) { // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -222815,7 +223509,9 @@ type SecurityPoliciesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all SecurityPolicy resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *SecurityPoliciesService) AggregatedList(project string) *SecurityPoliciesAggregatedListCall { @@ -222913,7 +223609,9 @@ func (c *SecurityPoliciesAggregatedListCall) PageToken(pageToken string) *Securi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SecurityPoliciesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SecurityPoliciesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -223027,7 +223725,7 @@ func (c *SecurityPoliciesAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/securityPolicies", // "httpMethod": "GET", // "id": "compute.securityPolicies.aggregatedList", @@ -223071,7 +223769,7 @@ func (c *SecurityPoliciesAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -223891,7 +224589,9 @@ func (c *SecurityPoliciesListCall) PageToken(pageToken string) *SecurityPolicies // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SecurityPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SecurityPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -224035,7 +224735,7 @@ func (c *SecurityPoliciesListCall) Do(opts ...googleapi.CallOption) (*SecurityPo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -224171,7 +224871,9 @@ func (c *SecurityPoliciesListPreconfiguredExpressionSetsCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SecurityPoliciesListPreconfiguredExpressionSetsCall) ReturnPartialSuccess(returnPartialSuccess bool) *SecurityPoliciesListPreconfiguredExpressionSetsCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -224318,7 +225020,7 @@ func (c *SecurityPoliciesListPreconfiguredExpressionSetsCall) Do(opts ...googlea // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -225219,6 +225921,8 @@ type ServiceAttachmentsAggregatedListCall struct { // AggregatedList: Retrieves the list of all ServiceAttachment // resources, regional and global, available to the specified project. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Name of the project scoping this request. func (r *ServiceAttachmentsService) AggregatedList(project string) *ServiceAttachmentsAggregatedListCall { @@ -225316,7 +226020,9 @@ func (c *ServiceAttachmentsAggregatedListCall) PageToken(pageToken string) *Serv // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ServiceAttachmentsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ServiceAttachmentsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -225430,7 +226136,7 @@ func (c *ServiceAttachmentsAggregatedListCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/serviceAttachments", // "httpMethod": "GET", // "id": "compute.serviceAttachments.aggregatedList", @@ -225474,7 +226180,7 @@ func (c *ServiceAttachmentsAggregatedListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -226334,7 +227040,9 @@ func (c *ServiceAttachmentsListCall) PageToken(pageToken string) *ServiceAttachm // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ServiceAttachmentsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ServiceAttachmentsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -226487,7 +227195,7 @@ func (c *ServiceAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ServiceA // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -227391,7 +228099,9 @@ type SnapshotsAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of all of the snapshots -// in your project across all regions and global scope. +// in your project across all regions and global scope. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Project ID for this request. func (r *SnapshotsService) AggregatedList(project string) *SnapshotsAggregatedListCall { @@ -227489,7 +228199,9 @@ func (c *SnapshotsAggregatedListCall) PageToken(pageToken string) *SnapshotsAggr // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SnapshotsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SnapshotsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -227603,7 +228315,7 @@ func (c *SnapshotsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Snapsho } return ret, nil // { - // "description": "Retrieves an aggregated list of all of the snapshots in your project across all regions and global scope.", + // "description": "Retrieves an aggregated list of all of the snapshots in your project across all regions and global scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/snapshots", // "httpMethod": "GET", // "id": "compute.snapshots.aggregatedList", @@ -227647,7 +228359,7 @@ func (c *SnapshotsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Snapsho // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -228462,7 +229174,9 @@ func (c *SnapshotsListCall) PageToken(pageToken string) *SnapshotsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SnapshotsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SnapshotsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -228606,7 +229320,7 @@ func (c *SnapshotsListCall) Do(opts ...googleapi.CallOption) (*SnapshotList, err // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -229126,7 +229840,9 @@ type SslCertificatesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all SslCertificate resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *SslCertificatesService) AggregatedList(project string) *SslCertificatesAggregatedListCall { @@ -229224,7 +229940,9 @@ func (c *SslCertificatesAggregatedListCall) PageToken(pageToken string) *SslCert // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SslCertificatesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SslCertificatesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -229338,7 +230056,7 @@ func (c *SslCertificatesAggregatedListCall) Do(opts ...googleapi.CallOption) (*S } return ret, nil // { - // "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/sslCertificates", // "httpMethod": "GET", // "id": "compute.sslCertificates.aggregatedList", @@ -229382,7 +230100,7 @@ func (c *SslCertificatesAggregatedListCall) Do(opts ...googleapi.CallOption) (*S // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -230015,7 +230733,9 @@ func (c *SslCertificatesListCall) PageToken(pageToken string) *SslCertificatesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SslCertificatesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SslCertificatesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -230159,7 +230879,7 @@ func (c *SslCertificatesListCall) Do(opts ...googleapi.CallOption) (*SslCertific // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -230367,7 +231087,9 @@ type SslPoliciesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all SslPolicy resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *SslPoliciesService) AggregatedList(project string) *SslPoliciesAggregatedListCall { @@ -230465,7 +231187,9 @@ func (c *SslPoliciesAggregatedListCall) PageToken(pageToken string) *SslPolicies // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SslPoliciesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SslPoliciesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -230579,7 +231303,7 @@ func (c *SslPoliciesAggregatedListCall) Do(opts ...googleapi.CallOption) (*SslPo } return ret, nil // { - // "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/sslPolicies", // "httpMethod": "GET", // "id": "compute.sslPolicies.aggregatedList", @@ -230623,7 +231347,7 @@ func (c *SslPoliciesAggregatedListCall) Do(opts ...googleapi.CallOption) (*SslPo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -231258,7 +231982,9 @@ func (c *SslPoliciesListCall) PageToken(pageToken string) *SslPoliciesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SslPoliciesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SslPoliciesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -231402,7 +232128,7 @@ func (c *SslPoliciesListCall) Do(opts ...googleapi.CallOption) (*SslPoliciesList // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -231538,7 +232264,9 @@ func (c *SslPoliciesListAvailableFeaturesCall) PageToken(pageToken string) *SslP // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SslPoliciesListAvailableFeaturesCall) ReturnPartialSuccess(returnPartialSuccess bool) *SslPoliciesListAvailableFeaturesCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -231684,7 +232412,7 @@ func (c *SslPoliciesListAvailableFeaturesCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -232048,6 +232776,8 @@ type StoragePoolTypesAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of storage pool types. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *StoragePoolTypesService) AggregatedList(project string) *StoragePoolTypesAggregatedListCall { @@ -232145,7 +232875,9 @@ func (c *StoragePoolTypesAggregatedListCall) PageToken(pageToken string) *Storag // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *StoragePoolTypesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *StoragePoolTypesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -232259,7 +232991,7 @@ func (c *StoragePoolTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves an aggregated list of storage pool types.", + // "description": "Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/storagePoolTypes", // "httpMethod": "GET", // "id": "compute.storagePoolTypes.aggregatedList", @@ -232303,7 +233035,7 @@ func (c *StoragePoolTypesAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -232620,7 +233352,9 @@ func (c *StoragePoolTypesListCall) PageToken(pageToken string) *StoragePoolTypes // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *StoragePoolTypesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *StoragePoolTypesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -232766,7 +233500,7 @@ func (c *StoragePoolTypesListCall) Do(opts ...googleapi.CallOption) (*StoragePoo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -232823,7 +233557,9 @@ type StoragePoolsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of storage pools. +// AggregatedList: Retrieves an aggregated list of storage pools. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *StoragePoolsService) AggregatedList(project string) *StoragePoolsAggregatedListCall { @@ -232921,7 +233657,9 @@ func (c *StoragePoolsAggregatedListCall) PageToken(pageToken string) *StoragePoo // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *StoragePoolsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *StoragePoolsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -233035,7 +233773,7 @@ func (c *StoragePoolsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Stor } return ret, nil // { - // "description": "Retrieves an aggregated list of storage pools.", + // "description": "Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/storagePools", // "httpMethod": "GET", // "id": "compute.storagePools.aggregatedList", @@ -233079,7 +233817,7 @@ func (c *StoragePoolsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Stor // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -233940,7 +234678,9 @@ func (c *StoragePoolsListCall) PageToken(pageToken string) *StoragePoolsListCall // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *StoragePoolsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *StoragePoolsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -234086,7 +234826,7 @@ func (c *StoragePoolsListCall) Do(opts ...googleapi.CallOption) (*StoragePoolLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -234234,7 +234974,9 @@ func (c *StoragePoolsListDisksCall) PageToken(pageToken string) *StoragePoolsLis // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *StoragePoolsListDisksCall) ReturnPartialSuccess(returnPartialSuccess bool) *StoragePoolsListDisksCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -234382,7 +235124,7 @@ func (c *StoragePoolsListDisksCall) Do(opts ...googleapi.CallOption) (*StoragePo // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -235176,7 +235918,9 @@ type SubnetworksAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of subnetworks. +// AggregatedList: Retrieves an aggregated list of subnetworks. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *SubnetworksService) AggregatedList(project string) *SubnetworksAggregatedListCall { @@ -235274,7 +236018,9 @@ func (c *SubnetworksAggregatedListCall) PageToken(pageToken string) *Subnetworks // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SubnetworksAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SubnetworksAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -235388,7 +236134,7 @@ func (c *SubnetworksAggregatedListCall) Do(opts ...googleapi.CallOption) (*Subne } return ret, nil // { - // "description": "Retrieves an aggregated list of subnetworks.", + // "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/subnetworks", // "httpMethod": "GET", // "id": "compute.subnetworks.aggregatedList", @@ -235432,7 +236178,7 @@ func (c *SubnetworksAggregatedListCall) Do(opts ...googleapi.CallOption) (*Subne // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -236479,7 +237225,9 @@ func (c *SubnetworksListCall) PageToken(pageToken string) *SubnetworksListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SubnetworksListCall) ReturnPartialSuccess(returnPartialSuccess bool) *SubnetworksListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -236632,7 +237380,7 @@ func (c *SubnetworksListCall) Do(opts ...googleapi.CallOption) (*SubnetworkList, // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -236768,7 +237516,9 @@ func (c *SubnetworksListUsableCall) PageToken(pageToken string) *SubnetworksList // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *SubnetworksListUsableCall) ReturnPartialSuccess(returnPartialSuccess bool) *SubnetworksListUsableCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -236921,7 +237671,7 @@ func (c *SubnetworksListUsableCall) Do(opts ...googleapi.CallOption) (*UsableSub // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -238292,7 +239042,9 @@ func (c *TargetGrpcProxiesListCall) PageToken(pageToken string) *TargetGrpcProxi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetGrpcProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetGrpcProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -238436,7 +239188,7 @@ func (c *TargetGrpcProxiesListCall) Do(opts ...googleapi.CallOption) (*TargetGrp // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -238822,7 +239574,9 @@ type TargetHttpProxiesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all TargetHttpProxy resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *TargetHttpProxiesService) AggregatedList(project string) *TargetHttpProxiesAggregatedListCall { @@ -238920,7 +239674,9 @@ func (c *TargetHttpProxiesAggregatedListCall) PageToken(pageToken string) *Targe // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetHttpProxiesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetHttpProxiesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -239034,7 +239790,7 @@ func (c *TargetHttpProxiesAggregatedListCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/targetHttpProxies", // "httpMethod": "GET", // "id": "compute.targetHttpProxies.aggregatedList", @@ -239078,7 +239834,7 @@ func (c *TargetHttpProxiesAggregatedListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -239711,7 +240467,9 @@ func (c *TargetHttpProxiesListCall) PageToken(pageToken string) *TargetHttpProxi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetHttpProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetHttpProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -239855,7 +240613,7 @@ func (c *TargetHttpProxiesListCall) Do(opts ...googleapi.CallOption) (*TargetHtt // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -240417,7 +241175,9 @@ type TargetHttpsProxiesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all TargetHttpsProxy resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *TargetHttpsProxiesService) AggregatedList(project string) *TargetHttpsProxiesAggregatedListCall { @@ -240515,7 +241275,9 @@ func (c *TargetHttpsProxiesAggregatedListCall) PageToken(pageToken string) *Targ // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetHttpsProxiesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetHttpsProxiesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -240629,7 +241391,7 @@ func (c *TargetHttpsProxiesAggregatedListCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/targetHttpsProxies", // "httpMethod": "GET", // "id": "compute.targetHttpsProxies.aggregatedList", @@ -240673,7 +241435,7 @@ func (c *TargetHttpsProxiesAggregatedListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -241306,7 +242068,9 @@ func (c *TargetHttpsProxiesListCall) PageToken(pageToken string) *TargetHttpsPro // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetHttpsProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetHttpsProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -241450,7 +242214,7 @@ func (c *TargetHttpsProxiesListCall) Do(opts ...googleapi.CallOption) (*TargetHt // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -242723,7 +243487,9 @@ type TargetInstancesAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of target instances. +// AggregatedList: Retrieves an aggregated list of target instances. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *TargetInstancesService) AggregatedList(project string) *TargetInstancesAggregatedListCall { @@ -242821,7 +243587,9 @@ func (c *TargetInstancesAggregatedListCall) PageToken(pageToken string) *TargetI // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetInstancesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetInstancesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -242935,7 +243703,7 @@ func (c *TargetInstancesAggregatedListCall) Do(opts ...googleapi.CallOption) (*T } return ret, nil // { - // "description": "Retrieves an aggregated list of target instances.", + // "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/targetInstances", // "httpMethod": "GET", // "id": "compute.targetInstances.aggregatedList", @@ -242979,7 +243747,7 @@ func (c *TargetInstancesAggregatedListCall) Do(opts ...googleapi.CallOption) (*T // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -243651,7 +244419,9 @@ func (c *TargetInstancesListCall) PageToken(pageToken string) *TargetInstancesLi // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetInstancesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetInstancesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -243797,7 +244567,7 @@ func (c *TargetInstancesListCall) Do(opts ...googleapi.CallOption) (*TargetInsta // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -244589,7 +245359,9 @@ type TargetPoolsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of target pools. +// AggregatedList: Retrieves an aggregated list of target pools. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *TargetPoolsService) AggregatedList(project string) *TargetPoolsAggregatedListCall { @@ -244687,7 +245459,9 @@ func (c *TargetPoolsAggregatedListCall) PageToken(pageToken string) *TargetPools // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetPoolsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetPoolsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -244801,7 +245575,7 @@ func (c *TargetPoolsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Targe } return ret, nil // { - // "description": "Retrieves an aggregated list of target pools.", + // "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/targetPools", // "httpMethod": "GET", // "id": "compute.targetPools.aggregatedList", @@ -244845,7 +245619,7 @@ func (c *TargetPoolsAggregatedListCall) Do(opts ...googleapi.CallOption) (*Targe // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -245687,7 +246461,9 @@ func (c *TargetPoolsListCall) PageToken(pageToken string) *TargetPoolsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetPoolsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetPoolsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -245840,7 +246616,7 @@ func (c *TargetPoolsListCall) Do(opts ...googleapi.CallOption) (*TargetPoolList, // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -247405,7 +248181,9 @@ func (c *TargetSslProxiesListCall) PageToken(pageToken string) *TargetSslProxies // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetSslProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetSslProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -247549,7 +248327,7 @@ func (c *TargetSslProxiesListCall) Do(opts ...googleapi.CallOption) (*TargetSslP // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -248645,7 +249423,9 @@ type TargetTcpProxiesAggregatedListCall struct { } // AggregatedList: Retrieves the list of all TargetTcpProxy resources, -// regional and global, available to the specified project. +// regional and global, available to the specified project. To prevent +// failure, Google recommends that you set the `returnPartialSuccess` +// parameter to `true`. // // - project: Name of the project scoping this request. func (r *TargetTcpProxiesService) AggregatedList(project string) *TargetTcpProxiesAggregatedListCall { @@ -248743,7 +249523,9 @@ func (c *TargetTcpProxiesAggregatedListCall) PageToken(pageToken string) *Target // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetTcpProxiesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetTcpProxiesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -248857,7 +249639,7 @@ func (c *TargetTcpProxiesAggregatedListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/targetTcpProxies", // "httpMethod": "GET", // "id": "compute.targetTcpProxies.aggregatedList", @@ -248901,7 +249683,7 @@ func (c *TargetTcpProxiesAggregatedListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -249534,7 +250316,9 @@ func (c *TargetTcpProxiesListCall) PageToken(pageToken string) *TargetTcpProxies // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetTcpProxiesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetTcpProxiesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -249678,7 +250462,7 @@ func (c *TargetTcpProxiesListCall) Do(opts ...googleapi.CallOption) (*TargetTcpP // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -250240,6 +251024,8 @@ type TargetVpnGatewaysAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of target VPN gateways. +// To prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *TargetVpnGatewaysService) AggregatedList(project string) *TargetVpnGatewaysAggregatedListCall { @@ -250337,7 +251123,9 @@ func (c *TargetVpnGatewaysAggregatedListCall) PageToken(pageToken string) *Targe // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetVpnGatewaysAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetVpnGatewaysAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -250451,7 +251239,7 @@ func (c *TargetVpnGatewaysAggregatedListCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Retrieves an aggregated list of target VPN gateways.", + // "description": "Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/targetVpnGateways", // "httpMethod": "GET", // "id": "compute.targetVpnGateways.aggregatedList", @@ -250495,7 +251283,7 @@ func (c *TargetVpnGatewaysAggregatedListCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -251167,7 +251955,9 @@ func (c *TargetVpnGatewaysListCall) PageToken(pageToken string) *TargetVpnGatewa // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *TargetVpnGatewaysListCall) ReturnPartialSuccess(returnPartialSuccess bool) *TargetVpnGatewaysListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -251320,7 +252110,7 @@ func (c *TargetVpnGatewaysListCall) Do(opts ...googleapi.CallOption) (*TargetVpn // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -251729,7 +252519,9 @@ type UrlMapsAggregatedListCall struct { } // AggregatedList: Retrieves the list of all UrlMap resources, regional -// and global, available to the specified project. +// and global, available to the specified project. To prevent failure, +// Google recommends that you set the `returnPartialSuccess` parameter +// to `true`. // // - project: Name of the project scoping this request. func (r *UrlMapsService) AggregatedList(project string) *UrlMapsAggregatedListCall { @@ -251827,7 +252619,9 @@ func (c *UrlMapsAggregatedListCall) PageToken(pageToken string) *UrlMapsAggregat // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *UrlMapsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *UrlMapsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -251941,7 +252735,7 @@ func (c *UrlMapsAggregatedListCall) Do(opts ...googleapi.CallOption) (*UrlMapsAg } return ret, nil // { - // "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project.", + // "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/urlMaps", // "httpMethod": "GET", // "id": "compute.urlMaps.aggregatedList", @@ -251985,7 +252779,7 @@ func (c *UrlMapsAggregatedListCall) Do(opts ...googleapi.CallOption) (*UrlMapsAg // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -252797,7 +253591,9 @@ func (c *UrlMapsListCall) PageToken(pageToken string) *UrlMapsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *UrlMapsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *UrlMapsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -252941,7 +253737,7 @@ func (c *UrlMapsListCall) Do(opts ...googleapi.CallOption) (*UrlMapList, error) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -253660,7 +254456,9 @@ type VpnGatewaysAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of VPN gateways. +// AggregatedList: Retrieves an aggregated list of VPN gateways. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *VpnGatewaysService) AggregatedList(project string) *VpnGatewaysAggregatedListCall { @@ -253758,7 +254556,9 @@ func (c *VpnGatewaysAggregatedListCall) PageToken(pageToken string) *VpnGateways // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *VpnGatewaysAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *VpnGatewaysAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -253872,7 +254672,7 @@ func (c *VpnGatewaysAggregatedListCall) Do(opts ...googleapi.CallOption) (*VpnGa } return ret, nil // { - // "description": "Retrieves an aggregated list of VPN gateways.", + // "description": "Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/vpnGateways", // "httpMethod": "GET", // "id": "compute.vpnGateways.aggregatedList", @@ -253916,7 +254716,7 @@ func (c *VpnGatewaysAggregatedListCall) Do(opts ...googleapi.CallOption) (*VpnGa // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -254760,7 +255560,9 @@ func (c *VpnGatewaysListCall) PageToken(pageToken string) *VpnGatewaysListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *VpnGatewaysListCall) ReturnPartialSuccess(returnPartialSuccess bool) *VpnGatewaysListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -254913,7 +255715,7 @@ func (c *VpnGatewaysListCall) Do(opts ...googleapi.CallOption) (*VpnGatewayList, // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -255321,7 +256123,9 @@ type VpnTunnelsAggregatedListCall struct { header_ http.Header } -// AggregatedList: Retrieves an aggregated list of VPN tunnels. +// AggregatedList: Retrieves an aggregated list of VPN tunnels. To +// prevent failure, Google recommends that you set the +// `returnPartialSuccess` parameter to `true`. // // - project: Project ID for this request. func (r *VpnTunnelsService) AggregatedList(project string) *VpnTunnelsAggregatedListCall { @@ -255419,7 +256223,9 @@ func (c *VpnTunnelsAggregatedListCall) PageToken(pageToken string) *VpnTunnelsAg // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *VpnTunnelsAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *VpnTunnelsAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -255533,7 +256339,7 @@ func (c *VpnTunnelsAggregatedListCall) Do(opts ...googleapi.CallOption) (*VpnTun } return ret, nil // { - // "description": "Retrieves an aggregated list of VPN tunnels.", + // "description": "Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/vpnTunnels", // "httpMethod": "GET", // "id": "compute.vpnTunnels.aggregatedList", @@ -255577,7 +256383,7 @@ func (c *VpnTunnelsAggregatedListCall) Do(opts ...googleapi.CallOption) (*VpnTun // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -256249,7 +257055,9 @@ func (c *VpnTunnelsListCall) PageToken(pageToken string) *VpnTunnelsListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *VpnTunnelsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *VpnTunnelsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -256402,7 +257210,7 @@ func (c *VpnTunnelsListCall) Do(opts ...googleapi.CallOption) (*VpnTunnelList, e // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } @@ -257200,7 +258008,9 @@ func (c *ZoneOperationsListCall) PageToken(pageToken string) *ZoneOperationsList // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ZoneOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ZoneOperationsListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -257346,7 +258156,7 @@ func (c *ZoneOperationsListCall) Do(opts ...googleapi.CallOption) (*OperationLis // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -257572,7 +258382,9 @@ type ZoneQueuedResourcesAggregatedListCall struct { } // AggregatedList: Retrieves an aggregated list of all of the queued -// resources in a project across all zones. +// resources in a project across all zones. To prevent failure, Google +// recommends that you set the `returnPartialSuccess` parameter to +// `true`. // // - project: Project ID for this request. func (r *ZoneQueuedResourcesService) AggregatedList(project string) *ZoneQueuedResourcesAggregatedListCall { @@ -257670,7 +258482,9 @@ func (c *ZoneQueuedResourcesAggregatedListCall) PageToken(pageToken string) *Zon // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ZoneQueuedResourcesAggregatedListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ZoneQueuedResourcesAggregatedListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -257784,7 +258598,7 @@ func (c *ZoneQueuedResourcesAggregatedListCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Retrieves an aggregated list of all of the queued resources in a project across all zones.", + // "description": "Retrieves an aggregated list of all of the queued resources in a project across all zones. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", // "flatPath": "projects/{project}/aggregated/queuedResources", // "httpMethod": "GET", // "id": "compute.zoneQueuedResources.aggregatedList", @@ -257828,7 +258642,7 @@ func (c *ZoneQueuedResourcesAggregatedListCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -258679,7 +259493,9 @@ func (c *ZoneQueuedResourcesListCall) PageToken(pageToken string) *ZoneQueuedRes // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ZoneQueuedResourcesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ZoneQueuedResourcesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -258825,7 +259641,7 @@ func (c *ZoneQueuedResourcesListCall) Do(opts ...googleapi.CallOption) (*QueuedR // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // }, @@ -259128,7 +259944,9 @@ func (c *ZonesListCall) PageToken(pageToken string) *ZonesListCall { // ReturnPartialSuccess sets the optional parameter // "returnPartialSuccess": Opt-in for partial success behavior which // provides partial results in case of failure. The default value is -// false. +// false. For example, when partial success behavior is enabled, +// aggregatedList for a single zone scope either returns all resources +// in the zone or no resources, with an error code. func (c *ZonesListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ZonesListCall { c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) return c @@ -259272,7 +260090,7 @@ func (c *ZonesListCall) Do(opts ...googleapi.CallOption) (*ZoneList, error) { // "type": "string" // }, // "returnPartialSuccess": { - // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + // "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", // "location": "query", // "type": "boolean" // } diff --git a/contactcenterinsights/v1/contactcenterinsights-api.json b/contactcenterinsights/v1/contactcenterinsights-api.json index 7e92c5e0497..052deb52806 100644 --- a/contactcenterinsights/v1/contactcenterinsights-api.json +++ b/contactcenterinsights/v1/contactcenterinsights-api.json @@ -1473,7 +1473,7 @@ } } }, - "revision": "20240212", + "revision": "20240219", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -3810,7 +3810,7 @@ "additionalProperties": { "type": "string" }, - "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", + "description": "A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * \"all-triggers\": Notify each time any of the supported triggers occurs. * \"create-analysis\": Notify each time an analysis is created. * \"create-conversation\": Notify each time a conversation is created. * \"export-insights-data\": Notify each time an export is complete. * \"update-conversation\": Notify each time a conversation is updated via UpdateConversation. * \"upload-conversation\": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}", "type": "object" }, "redactionConfig": { diff --git a/contactcenterinsights/v1/contactcenterinsights-gen.go b/contactcenterinsights/v1/contactcenterinsights-gen.go index e062b4af8e8..b4de822f4d3 100644 --- a/contactcenterinsights/v1/contactcenterinsights-gen.go +++ b/contactcenterinsights/v1/contactcenterinsights-gen.go @@ -4066,9 +4066,10 @@ type GoogleCloudContactcenterinsightsV1Settings struct { // time an analysis is created. * "create-conversation": Notify each // time a conversation is created. * "export-insights-data": Notify each // time an export is complete. * "update-conversation": Notify each time - // a conversation is updated via UpdateConversation. Values are Pub/Sub - // topics. The format of each Pub/Sub topic is: - // projects/{project}/topics/{topic} + // a conversation is updated via UpdateConversation. * + // "upload-conversation": Notify when an UploadConversation LRO + // completes. Values are Pub/Sub topics. The format of each Pub/Sub + // topic is: projects/{project}/topics/{topic} PubsubNotificationSettings map[string]string `json:"pubsubNotificationSettings,omitempty"` // RedactionConfig: Default DLP redaction resources to be applied while diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json index 68c36a2132c..8b0e2e2e371 100644 --- a/dataflow/v1b3/dataflow-api.json +++ b/dataflow/v1b3/dataflow-api.json @@ -10,9 +10,6 @@ }, "https://www.googleapis.com/auth/compute.readonly": { "description": "View your Google Compute Engine resources" - }, - "https://www.googleapis.com/auth/userinfo.email": { - "description": "See your primary Google Account email address" } } } @@ -156,8 +153,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "workerMessages": { @@ -186,8 +182,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } }, @@ -273,8 +268,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "create": { @@ -330,8 +324,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "get": { @@ -386,8 +379,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "getMetrics": { @@ -431,8 +423,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "list": { @@ -514,8 +505,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "snapshot": { @@ -551,8 +541,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "update": { @@ -599,8 +588,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } }, @@ -640,8 +628,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "sendCapture": { @@ -677,8 +664,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -764,8 +750,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -805,8 +790,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "reportStatus": { @@ -842,8 +826,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -885,8 +868,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } }, @@ -926,8 +908,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -989,8 +970,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "get": { @@ -1047,8 +1027,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "getExecutionDetails": { @@ -1099,8 +1078,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "getMetrics": { @@ -1146,8 +1124,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "list": { @@ -1231,8 +1208,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "snapshot": { @@ -1275,8 +1251,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "update": { @@ -1325,8 +1300,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } }, @@ -1373,8 +1347,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "sendCapture": { @@ -1417,8 +1390,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -1506,8 +1478,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -1551,8 +1522,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -1626,8 +1596,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -1674,8 +1643,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "reportStatus": { @@ -1718,8 +1686,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -1765,8 +1732,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "get": { @@ -1806,8 +1772,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "list": { @@ -1845,8 +1810,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -1886,8 +1850,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "get": { @@ -1936,8 +1899,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "launch": { @@ -1993,8 +1955,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -2038,8 +1999,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "list": { @@ -2075,8 +2035,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -2109,8 +2068,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "get": { @@ -2157,8 +2115,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] }, "launch": { @@ -2212,8 +2169,7 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -2221,7 +2177,7 @@ } } }, - "revision": "20240121", + "revision": "20240218", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3459,7 +3415,7 @@ "type": "object" }, "FlexTemplateRuntimeEnvironment": { - "description": "The environment values to be set at runtime for flex template.", + "description": "The environment values to be set at runtime for flex template. LINT.IfChange", "id": "FlexTemplateRuntimeEnvironment", "properties": { "additionalExperiments": { @@ -6773,6 +6729,18 @@ }, "type": "object" }, + "StreamingScalingReportResponse": { + "description": "Contains per-user-worker streaming scaling recommendation from the backend.", + "id": "StreamingScalingReportResponse", + "properties": { + "maximumThreadCount": { + "description": "Maximum thread count limit;", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "StreamingSetupTask": { "description": "A task which initializes part of a streaming Dataflow job.", "id": "StreamingSetupTask", @@ -7581,6 +7549,10 @@ "description": "A worker_message response allows the server to pass information to the sender.", "id": "WorkerMessageResponse", "properties": { + "streamingScalingReportResponse": { + "$ref": "StreamingScalingReportResponse", + "description": "Service's streaming scaling response for workers." + }, "workerHealthReportResponse": { "$ref": "WorkerHealthReportResponse", "description": "The service's response to a worker's health report." diff --git a/dataflow/v1b3/dataflow-gen.go b/dataflow/v1b3/dataflow-gen.go index f803999f091..eac32c896da 100644 --- a/dataflow/v1b3/dataflow-gen.go +++ b/dataflow/v1b3/dataflow-gen.go @@ -37,7 +37,7 @@ // By default, all available scopes (see "Constants") are used to authenticate. // To restrict scopes, use [google.golang.org/api/option.WithScopes]: // -// dataflowService, err := dataflow.NewService(ctx, option.WithScopes(dataflow.UserinfoEmailScope)) +// dataflowService, err := dataflow.NewService(ctx, option.WithScopes(dataflow.ComputeReadonlyScope)) // // To use an API key for authentication (note: some APIs do not support API // keys), use [google.golang.org/api/option.WithAPIKey]: @@ -110,9 +110,6 @@ const ( // View your Google Compute Engine resources ComputeReadonlyScope = "https://www.googleapis.com/auth/compute.readonly" - - // See your primary Google Account email address - UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email" ) // NewService creates a new Service. @@ -121,7 +118,6 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email", ) // NOTE: prepend, so we don't override user-specified scopes. opts = append([]option.ClientOption{scopesOption}, opts...) @@ -2326,7 +2322,7 @@ func (s *FlattenInstruction) MarshalJSON() ([]byte, error) { } // FlexTemplateRuntimeEnvironment: The environment values to be set at -// runtime for flex template. +// runtime for flex template. LINT.IfChange type FlexTemplateRuntimeEnvironment struct { // AdditionalExperiments: Additional experiment flags for the job. AdditionalExperiments []string `json:"additionalExperiments,omitempty"` @@ -7598,6 +7594,36 @@ func (s *StreamingScalingReport) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// StreamingScalingReportResponse: Contains per-user-worker streaming +// scaling recommendation from the backend. +type StreamingScalingReportResponse struct { + // MaximumThreadCount: Maximum thread count limit; + MaximumThreadCount int64 `json:"maximumThreadCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MaximumThreadCount") + // 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. "MaximumThreadCount") 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 *StreamingScalingReportResponse) MarshalJSON() ([]byte, error) { + type NoMethod StreamingScalingReportResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // StreamingSetupTask: A task which initializes part of a streaming // Dataflow job. type StreamingSetupTask struct { @@ -8702,6 +8728,10 @@ func (s *WorkerMessageCode) MarshalJSON() ([]byte, error) { // WorkerMessageResponse: A worker_message response allows the server to // pass information to the sender. type WorkerMessageResponse struct { + // StreamingScalingReportResponse: Service's streaming scaling response + // for workers. + StreamingScalingReportResponse *StreamingScalingReportResponse `json:"streamingScalingReportResponse,omitempty"` + // WorkerHealthReportResponse: The service's response to a worker's // health report. WorkerHealthReportResponse *WorkerHealthReportResponse `json:"workerHealthReportResponse,omitempty"` @@ -8719,7 +8749,7 @@ type WorkerMessageResponse struct { WorkerThreadScalingReportResponse *WorkerThreadScalingReportResponse `json:"workerThreadScalingReportResponse,omitempty"` // ForceSendFields is a list of field names (e.g. - // "WorkerHealthReportResponse") to unconditionally include in API + // "StreamingScalingReportResponse") 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 @@ -8728,7 +8758,7 @@ type WorkerMessageResponse struct { ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. - // "WorkerHealthReportResponse") to include in API requests with the + // "StreamingScalingReportResponse") 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 @@ -9235,8 +9265,7 @@ func (c *ProjectsDeleteSnapshotsCall) Do(opts ...googleapi.CallOption) (*DeleteS // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -9379,8 +9408,7 @@ func (c *ProjectsWorkerMessagesCall) Do(opts ...googleapi.CallOption) (*SendWork // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -9675,8 +9703,7 @@ func (c *ProjectsJobsAggregatedCall) Do(opts ...googleapi.CallOption) (*ListJobs // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -9921,8 +9948,7 @@ func (c *ProjectsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -10149,8 +10175,7 @@ func (c *ProjectsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error) { // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -10341,8 +10366,7 @@ func (c *ProjectsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetri // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -10645,8 +10669,7 @@ func (c *ProjectsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsRespon // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -10821,8 +10844,7 @@ func (c *ProjectsJobsSnapshotCall) Do(opts ...googleapi.CallOption) (*Snapshot, // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -11014,8 +11036,7 @@ func (c *ProjectsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job, error) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -11170,8 +11191,7 @@ func (c *ProjectsJobsDebugGetConfigCall) Do(opts ...googleapi.CallOption) (*GetD // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -11325,8 +11345,7 @@ func (c *ProjectsJobsDebugSendCaptureCall) Do(opts ...googleapi.CallOption) (*Se // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -11627,8 +11646,7 @@ func (c *ProjectsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJo // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -11803,8 +11821,7 @@ func (c *ProjectsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOption) (*Leas // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -11959,8 +11976,7 @@ func (c *ProjectsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.CallOption) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -12116,8 +12132,7 @@ func (c *ProjectsLocationsWorkerMessagesCall) Do(opts ...googleapi.CallOption) ( // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -12274,8 +12289,7 @@ func (c *ProjectsLocationsFlexTemplatesLaunchCall) Do(opts ...googleapi.CallOpti // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -12498,8 +12512,7 @@ func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -12725,8 +12738,7 @@ func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, e // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -12927,8 +12939,7 @@ func (c *ProjectsLocationsJobsGetExecutionDetailsCall) Do(opts ...googleapi.Call // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -13139,8 +13150,7 @@ func (c *ProjectsLocationsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) ( // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -13442,8 +13452,7 @@ func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJ // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -13629,8 +13638,7 @@ func (c *ProjectsLocationsJobsSnapshotCall) Do(opts ...googleapi.CallOption) (*S // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -13821,8 +13829,7 @@ func (c *ProjectsLocationsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -13990,8 +13997,7 @@ func (c *ProjectsLocationsJobsDebugGetConfigCall) Do(opts ...googleapi.CallOptio // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -14158,8 +14164,7 @@ func (c *ProjectsLocationsJobsDebugSendCaptureCall) Do(opts ...googleapi.CallOpt // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -14459,8 +14464,7 @@ func (c *ProjectsLocationsJobsMessagesListCall) Do(opts ...googleapi.CallOption) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -14650,8 +14654,7 @@ func (c *ProjectsLocationsJobsSnapshotsListCall) Do(opts ...googleapi.CallOption // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -14889,8 +14892,7 @@ func (c *ProjectsLocationsJobsStagesGetExecutionDetailsCall) Do(opts ...googleap // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -15078,8 +15080,7 @@ func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOptio // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -15247,8 +15248,7 @@ func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.Ca // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -15404,8 +15404,7 @@ func (c *ProjectsLocationsSnapshotsDeleteCall) Do(opts ...googleapi.CallOption) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -15575,8 +15574,7 @@ func (c *ProjectsLocationsSnapshotsGetCall) Do(opts ...googleapi.CallOption) (*S // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -15746,8 +15744,7 @@ func (c *ProjectsLocationsSnapshotsListCall) Do(opts ...googleapi.CallOption) (* // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -15905,8 +15902,7 @@ func (c *ProjectsLocationsTemplatesCreateCall) Do(opts ...googleapi.CallOption) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -16104,8 +16100,7 @@ func (c *ProjectsLocationsTemplatesGetCall) Do(opts ...googleapi.CallOption) (*G // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -16315,8 +16310,7 @@ func (c *ProjectsLocationsTemplatesLaunchCall) Do(opts ...googleapi.CallOption) // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -16487,8 +16481,7 @@ func (c *ProjectsSnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot, // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -16659,8 +16652,7 @@ func (c *ProjectsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnaps // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -16805,8 +16797,7 @@ func (c *ProjectsTemplatesCreateCall) Do(opts ...googleapi.CallOption) (*Job, er // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -17005,8 +16996,7 @@ func (c *ProjectsTemplatesGetCall) Do(opts ...googleapi.CallOption) (*GetTemplat // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } @@ -17217,8 +17207,7 @@ func (c *ProjectsTemplatesLaunchCall) Do(opts ...googleapi.CallOption) (*LaunchT // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform", // "https://www.googleapis.com/auth/compute", - // "https://www.googleapis.com/auth/compute.readonly", - // "https://www.googleapis.com/auth/userinfo.email" + // "https://www.googleapis.com/auth/compute.readonly" // ] // } diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json index bdb56dd5580..3a04b1f87c6 100644 --- a/datastore/v1/datastore-api.json +++ b/datastore/v1/datastore-api.json @@ -654,7 +654,7 @@ } } }, - "revision": "20240208", + "revision": "20240215", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -993,17 +993,6 @@ }, "type": "object" }, - "ExplainOptions": { - "description": "Explain options for the query.", - "id": "ExplainOptions", - "properties": { - "analyze": { - "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", - "type": "boolean" - } - }, - "type": "object" - }, "Filter": { "description": "A holder for any type of filter.", "id": "Filter", @@ -2320,10 +2309,6 @@ "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", "type": "string" }, - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be an aggregation query." @@ -2367,10 +2352,6 @@ "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", "type": "string" }, - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be a non-aggregation query." diff --git a/datastore/v1/datastore-gen.go b/datastore/v1/datastore-gen.go index 4d8565c6195..4eb8dcb16d5 100644 --- a/datastore/v1/datastore-gen.go +++ b/datastore/v1/datastore-gen.go @@ -839,38 +839,6 @@ func (s *EntityResult) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExplainOptions: Explain options for the query. -type ExplainOptions struct { - // Analyze: Optional. Whether to execute this query. When false (the - // default), the query will be planned, returning only metrics from the - // planning stages. When true, the query will be planned and executed, - // returning the full query results along with both planning and - // execution stage metrics. - Analyze bool `json:"analyze,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Analyze") 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. "Analyze") 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 *ExplainOptions) MarshalJSON() ([]byte, error) { - type NoMethod ExplainOptions - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // Filter: A holder for any type of filter. type Filter struct { // CompositeFilter: A composite filter. @@ -3054,11 +3022,6 @@ type RunAggregationQueryRequest struct { // default database. DatabaseId string `json:"databaseId,omitempty"` - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // GqlQuery: The GQL query to run. This query must be an aggregation // query. GqlQuery *GqlQuery `json:"gqlQuery,omitempty"` @@ -3146,11 +3109,6 @@ type RunQueryRequest struct { // default database. DatabaseId string `json:"databaseId,omitempty"` - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // GqlQuery: The GQL query to run. This query must be a non-aggregation // query. GqlQuery *GqlQuery `json:"gqlQuery,omitempty"` diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json index de6a8848d2b..7e6ed92e48f 100644 --- a/datastore/v1beta3/datastore-api.json +++ b/datastore/v1beta3/datastore-api.json @@ -336,7 +336,7 @@ } } }, - "revision": "20240208", + "revision": "20240215", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -653,17 +653,6 @@ }, "type": "object" }, - "ExplainOptions": { - "description": "Explain options for the query.", - "id": "ExplainOptions", - "properties": { - "analyze": { - "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", - "type": "boolean" - } - }, - "type": "object" - }, "Filter": { "description": "A holder for any type of filter.", "id": "Filter", @@ -1754,10 +1743,6 @@ "$ref": "AggregationQuery", "description": "The query to run." }, - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be an aggregation query." @@ -1792,10 +1777,6 @@ "description": "The request for Datastore.RunQuery.", "id": "RunQueryRequest", "properties": { - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be a non-aggregation query." diff --git a/datastore/v1beta3/datastore-gen.go b/datastore/v1beta3/datastore-gen.go index 90b74963980..a430fd57b0d 100644 --- a/datastore/v1beta3/datastore-gen.go +++ b/datastore/v1beta3/datastore-gen.go @@ -784,38 +784,6 @@ func (s *EntityResult) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExplainOptions: Explain options for the query. -type ExplainOptions struct { - // Analyze: Optional. Whether to execute this query. When false (the - // default), the query will be planned, returning only metrics from the - // planning stages. When true, the query will be planned and executed, - // returning the full query results along with both planning and - // execution stage metrics. - Analyze bool `json:"analyze,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Analyze") 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. "Analyze") 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 *ExplainOptions) MarshalJSON() ([]byte, error) { - type NoMethod ExplainOptions - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // Filter: A holder for any type of filter. type Filter struct { // CompositeFilter: A composite filter. @@ -2621,11 +2589,6 @@ type RunAggregationQueryRequest struct { // AggregationQuery: The query to run. AggregationQuery *AggregationQuery `json:"aggregationQuery,omitempty"` - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // GqlQuery: The GQL query to run. This query must be an aggregation // query. GqlQuery *GqlQuery `json:"gqlQuery,omitempty"` @@ -2702,11 +2665,6 @@ func (s *RunAggregationQueryResponse) MarshalJSON() ([]byte, error) { // RunQueryRequest: The request for Datastore.RunQuery. type RunQueryRequest struct { - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // GqlQuery: The GQL query to run. This query must be a non-aggregation // query. GqlQuery *GqlQuery `json:"gqlQuery,omitempty"` @@ -2723,7 +2681,7 @@ type RunQueryRequest struct { // ReadOptions: The options for this query. ReadOptions *ReadOptions `json:"readOptions,omitempty"` - // ForceSendFields is a list of field names (e.g. "ExplainOptions") to + // ForceSendFields is a list of field names (e.g. "GqlQuery") 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 @@ -2731,13 +2689,12 @@ type RunQueryRequest struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ExplainOptions") 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. "GqlQuery") 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:"-"` } diff --git a/firestore/v1/firestore-api.json b/firestore/v1/firestore-api.json index c825a4510e5..2c5903687b9 100644 --- a/firestore/v1/firestore-api.json +++ b/firestore/v1/firestore-api.json @@ -1672,7 +1672,7 @@ } } }, - "revision": "20240208", + "revision": "20240215", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2179,17 +2179,6 @@ }, "type": "object" }, - "ExplainOptions": { - "description": "Explain options for the query.", - "id": "ExplainOptions", - "properties": { - "analyze": { - "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", - "type": "boolean" - } - }, - "type": "object" - }, "FieldFilter": { "description": "A filter on a specific field.", "id": "FieldFilter", @@ -3801,10 +3790,6 @@ "description": "The request for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryRequest", "properties": { - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream." @@ -3851,10 +3836,6 @@ "description": "The request for Firestore.RunQuery.", "id": "RunQueryRequest", "properties": { - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream." diff --git a/firestore/v1/firestore-gen.go b/firestore/v1/firestore-gen.go index 42601bb8ddc..701ff2b612b 100644 --- a/firestore/v1/firestore-gen.go +++ b/firestore/v1/firestore-gen.go @@ -1301,38 +1301,6 @@ func (s *ExistenceFilter) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExplainOptions: Explain options for the query. -type ExplainOptions struct { - // Analyze: Optional. Whether to execute this query. When false (the - // default), the query will be planned, returning only metrics from the - // planning stages. When true, the query will be planned and executed, - // returning the full query results along with both planning and - // execution stage metrics. - Analyze bool `json:"analyze,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Analyze") 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. "Analyze") 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 *ExplainOptions) MarshalJSON() ([]byte, error) { - type NoMethod ExplainOptions - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // FieldFilter: A filter on a specific field. type FieldFilter struct { // Field: The field to filter by. @@ -3992,11 +3960,6 @@ func (s *RollbackRequest) MarshalJSON() ([]byte, error) { // RunAggregationQueryRequest: The request for // Firestore.RunAggregationQuery. type RunAggregationQueryRequest struct { - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // NewTransaction: Starts a new transaction as part of the query, // defaulting to read-only. The new transaction ID will be returned as // the first response in the stream. @@ -4016,7 +3979,7 @@ type RunAggregationQueryRequest struct { // the query in. Transaction string `json:"transaction,omitempty"` - // ForceSendFields is a list of field names (e.g. "ExplainOptions") to + // ForceSendFields is a list of field names (e.g. "NewTransaction") 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 @@ -4024,7 +3987,7 @@ type RunAggregationQueryRequest struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ExplainOptions") to + // NullFields is a list of field names (e.g. "NewTransaction") 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 @@ -4089,11 +4052,6 @@ func (s *RunAggregationQueryResponse) MarshalJSON() ([]byte, error) { // RunQueryRequest: The request for Firestore.RunQuery. type RunQueryRequest struct { - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // NewTransaction: Starts a new transaction and reads the documents. // Defaults to a read-only transaction. The new transaction ID will be // returned as the first response in the stream. @@ -4112,7 +4070,7 @@ type RunQueryRequest struct { // value here is the opaque transaction ID to execute the query in. Transaction string `json:"transaction,omitempty"` - // ForceSendFields is a list of field names (e.g. "ExplainOptions") to + // ForceSendFields is a list of field names (e.g. "NewTransaction") 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 @@ -4120,7 +4078,7 @@ type RunQueryRequest struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ExplainOptions") to + // NullFields is a list of field names (e.g. "NewTransaction") 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 diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json index c6077b68d68..c672e8d3b02 100644 --- a/firestore/v1beta1/firestore-api.json +++ b/firestore/v1beta1/firestore-api.json @@ -950,7 +950,7 @@ } } }, - "revision": "20240208", + "revision": "20240215", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1457,17 +1457,6 @@ }, "type": "object" }, - "ExplainOptions": { - "description": "Explain options for the query.", - "id": "ExplainOptions", - "properties": { - "analyze": { - "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", - "type": "boolean" - } - }, - "type": "object" - }, "FieldFilter": { "description": "A filter on a specific field.", "id": "FieldFilter", @@ -2319,10 +2308,6 @@ "description": "The request for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryRequest", "properties": { - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream." @@ -2369,10 +2354,6 @@ "description": "The request for Firestore.RunQuery.", "id": "RunQueryRequest", "properties": { - "explainOptions": { - "$ref": "ExplainOptions", - "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." - }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream." diff --git a/firestore/v1beta1/firestore-gen.go b/firestore/v1beta1/firestore-gen.go index 45c2f88d7d3..1352bf54e22 100644 --- a/firestore/v1beta1/firestore-gen.go +++ b/firestore/v1beta1/firestore-gen.go @@ -1229,38 +1229,6 @@ func (s *ExistenceFilter) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExplainOptions: Explain options for the query. -type ExplainOptions struct { - // Analyze: Optional. Whether to execute this query. When false (the - // default), the query will be planned, returning only metrics from the - // planning stages. When true, the query will be planned and executed, - // returning the full query results along with both planning and - // execution stage metrics. - Analyze bool `json:"analyze,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Analyze") 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. "Analyze") 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 *ExplainOptions) MarshalJSON() ([]byte, error) { - type NoMethod ExplainOptions - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // FieldFilter: A filter on a specific field. type FieldFilter struct { // Field: The field to filter by. @@ -2746,11 +2714,6 @@ func (s *RollbackRequest) MarshalJSON() ([]byte, error) { // RunAggregationQueryRequest: The request for // Firestore.RunAggregationQuery. type RunAggregationQueryRequest struct { - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // NewTransaction: Starts a new transaction as part of the query, // defaulting to read-only. The new transaction ID will be returned as // the first response in the stream. @@ -2770,7 +2733,7 @@ type RunAggregationQueryRequest struct { // the query in. Transaction string `json:"transaction,omitempty"` - // ForceSendFields is a list of field names (e.g. "ExplainOptions") to + // ForceSendFields is a list of field names (e.g. "NewTransaction") 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 @@ -2778,7 +2741,7 @@ type RunAggregationQueryRequest struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ExplainOptions") to + // NullFields is a list of field names (e.g. "NewTransaction") 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 @@ -2843,11 +2806,6 @@ func (s *RunAggregationQueryResponse) MarshalJSON() ([]byte, error) { // RunQueryRequest: The request for Firestore.RunQuery. type RunQueryRequest struct { - // ExplainOptions: Optional. Explain options for the query. If set, - // additional query statistics will be returned. If not, only query - // results will be returned. - ExplainOptions *ExplainOptions `json:"explainOptions,omitempty"` - // NewTransaction: Starts a new transaction and reads the documents. // Defaults to a read-only transaction. The new transaction ID will be // returned as the first response in the stream. @@ -2866,7 +2824,7 @@ type RunQueryRequest struct { // value here is the opaque transaction ID to execute the query in. Transaction string `json:"transaction,omitempty"` - // ForceSendFields is a list of field names (e.g. "ExplainOptions") to + // ForceSendFields is a list of field names (e.g. "NewTransaction") 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 @@ -2874,7 +2832,7 @@ type RunQueryRequest struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ExplainOptions") to + // NullFields is a list of field names (e.g. "NewTransaction") 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 diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json index e3da5ec13e9..5b25f75d3dd 100644 --- a/language/v1beta2/language-api.json +++ b/language/v1beta2/language-api.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240217", + "revision": "20240220", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -465,12 +465,47 @@ "type": "string" }, "features": { - "$ref": "Features", + "$ref": "AnnotateTextRequestFeatures", "description": "Required. The enabled features." } }, "type": "object" }, + "AnnotateTextRequestFeatures": { + "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 12", + "id": "AnnotateTextRequestFeatures", + "properties": { + "classificationModelOptions": { + "$ref": "ClassificationModelOptions", + "description": "Optional. The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true." + }, + "classifyText": { + "description": "Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).", + "type": "boolean" + }, + "extractDocumentSentiment": { + "description": "Extract document-level sentiment.", + "type": "boolean" + }, + "extractEntities": { + "description": "Extract entities.", + "type": "boolean" + }, + "extractEntitySentiment": { + "description": "Extract entities and their associated sentiment.", + "type": "boolean" + }, + "extractSyntax": { + "description": "Extract syntax information.", + "type": "boolean" + }, + "moderateText": { + "description": "Moderate the document for harmful and sensitive categories.", + "type": "boolean" + } + }, + "type": "object" + }, "AnnotateTextResponse": { "description": "The text annotations response message.", "id": "AnnotateTextResponse", @@ -542,16 +577,43 @@ "id": "ClassificationModelOptions", "properties": { "v1Model": { - "$ref": "V1Model", + "$ref": "ClassificationModelOptionsV1Model", "description": "Setting this field will use the V1 model and V1 content categories version. The V1 model is a legacy model; support for this will be discontinued in the future." }, "v2Model": { - "$ref": "V2Model", + "$ref": "ClassificationModelOptionsV2Model", "description": "Setting this field will use the V2 model with the appropriate content categories version. The V2 model is a better performing model." } }, "type": "object" }, + "ClassificationModelOptionsV1Model": { + "description": "Options for the V1 model.", + "id": "ClassificationModelOptionsV1Model", + "properties": {}, + "type": "object" + }, + "ClassificationModelOptionsV2Model": { + "description": "Options for the V2 model.", + "id": "ClassificationModelOptionsV2Model", + "properties": { + "contentCategoriesVersion": { + "description": "The content categories used for classification.", + "enum": [ + "CONTENT_CATEGORIES_VERSION_UNSPECIFIED", + "V1", + "V2" + ], + "enumDescriptions": [ + "If `ContentCategoriesVersion` is not specified, this option will default to `V1`.", + "Legacy content categories of our initial launch in 2017.", + "Updated content categories in 2022." + ], + "type": "string" + } + }, + "type": "object" + }, "ClassifyTextRequest": { "description": "The document classification request message.", "id": "ClassifyTextRequest", @@ -581,6 +643,419 @@ }, "type": "object" }, + "Color": { + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:\u0026red green:\u0026green blue:\u0026blue alpha:\u0026alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", + "id": "Color", + "properties": { + "alpha": { + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", + "format": "float", + "type": "number" + }, + "blue": { + "description": "The amount of blue in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "green": { + "description": "The amount of green in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CpuMetric": { + "description": "Metric for billing reports.", + "id": "CpuMetric", + "properties": { + "coreNumber": { + "description": "Required. Number of CPU cores.", + "format": "int64", + "type": "string" + }, + "coreSec": { + "description": "Required. Total seconds of core usage, e.g. 4.", + "format": "int64", + "type": "string" + }, + "cpuType": { + "description": "Required. Type of cpu, e.g. N2.", + "enum": [ + "UNKNOWN_CPU_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "GPU-based machine, skip quota reporting.", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, "DependencyEdge": { "description": "Represents dependency parse tree information for a token.", "id": "DependencyEdge", @@ -767,6 +1242,37 @@ }, "type": "object" }, + "DiskMetric": { + "id": "DiskMetric", + "properties": { + "diskType": { + "description": "Required. Type of Disk, e.g. REGIONAL_SSD.", + "enum": [ + "UNKNOWN_DISK_TYPE", + "REGIONAL_SSD", + "REGIONAL_STORAGE", + "PD_SSD", + "PD_STANDARD", + "STORAGE_SNAPSHOT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "gibSec": { + "description": "Required. Seconds of physical disk usage, e.g. 3600.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Document": { "description": "Represents the input to API methods.", "id": "Document", @@ -915,37 +1421,414 @@ }, "type": "object" }, - "Features": { - "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 12", - "id": "Features", + "GpuMetric": { + "id": "GpuMetric", "properties": { - "classificationModelOptions": { - "$ref": "ClassificationModelOptions", - "description": "Optional. The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true." + "gpuSec": { + "description": "Required. Seconds of GPU usage, e.g. 3600.", + "format": "int64", + "type": "string" }, - "classifyText": { - "description": "Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).", - "type": "boolean" + "gpuType": { + "description": "Required. Type of GPU, e.g. NVIDIA_TESLA_V100.", + "enum": [ + "UNKNOWN_GPU_TYPE", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_TESLA_K80", + "NVIDIA_L4", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_V100", + "NVIDIA_H100_80GB" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "extractDocumentSentiment": { - "description": "Extract document-level sentiment.", - "type": "boolean" + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "extractEntities": { - "description": "Extract entities.", - "type": "boolean" + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, + "InfraUsage": { + "description": "Infra Usage of billing metrics. Next ID: 6", + "id": "InfraUsage", + "properties": { + "cpuMetrics": { + "description": "Aggregated core metrics since requested start_time.", + "items": { + "$ref": "CpuMetric" + }, + "type": "array" }, - "extractEntitySentiment": { - "description": "Extract entities and their associated sentiment.", - "type": "boolean" + "diskMetrics": { + "description": "Aggregated persistent disk metrics since requested start_time.", + "items": { + "$ref": "DiskMetric" + }, + "type": "array" }, - "extractSyntax": { - "description": "Extract syntax information.", - "type": "boolean" + "gpuMetrics": { + "description": "Aggregated gpu metrics since requested start_time.", + "items": { + "$ref": "GpuMetric" + }, + "type": "array" }, - "moderateText": { - "description": "Moderate the document for harmful and sensitive categories.", - "type": "boolean" + "ramMetrics": { + "description": "Aggregated ram metrics since requested start_time.", + "items": { + "$ref": "RamMetric" + }, + "type": "array" + }, + "tpuMetrics": { + "description": "Aggregated tpu metrics since requested start_time.", + "items": { + "$ref": "TpuMetric" + }, + "type": "array" } }, "type": "object" @@ -1242,6 +2125,391 @@ }, "type": "object" }, + "RamMetric": { + "id": "RamMetric", + "properties": { + "gibSec": { + "description": "Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type to match billing metrics definition.", + "format": "int64", + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "memories": { + "description": "Required. VM memory in gb.", + "format": "double", + "type": "number" + }, + "ramType": { + "description": "Required. Type of ram.", + "enum": [ + "UNKNOWN_RAM_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "", + "", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, "Sentence": { "description": "Represents a sentence in the input document.", "id": "Sentence", @@ -1340,32 +2608,3079 @@ }, "type": "object" }, - "V1Model": { - "description": "Options for the V1 model.", - "id": "V1Model", - "properties": {}, - "type": "object" - }, - "V2Model": { - "description": "Options for the V2 model.", - "id": "V2Model", + "TpuMetric": { + "id": "TpuMetric", "properties": { - "contentCategoriesVersion": { - "description": "The content categories used for classification.", + "tpuSec": { + "description": "Required. Seconds of TPU usage, e.g. 3600.", + "format": "int64", + "type": "string" + }, + "tpuType": { + "description": "Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD.", "enum": [ - "CONTENT_CATEGORIES_VERSION_UNSPECIFIED", - "V1", - "V2" + "UNKNOWN_TPU_TYPE", + "TPU_V2_POD", + "TPU_V2", + "TPU_V3_POD", + "TPU_V3", + "TPU_V5_LITEPOD" ], "enumDescriptions": [ - "If `ContentCategoriesVersion` is not specified, this option will default to `V1`.", - "Legacy content categories of our initial launch in 2017.", - "Updated content categories in 2022." + "", + "", + "", + "", + "", + "" ], "type": "string" } }, "type": "object" + }, + "XPSArrayStats": { + "description": "The data statistics of a series of ARRAY values.", + "id": "XPSArrayStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "memberStats": { + "$ref": "XPSDataStats", + "description": "Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array." + } + }, + "type": "object" + }, + "XPSBatchPredictResponse": { + "id": "XPSBatchPredictResponse", + "properties": { + "exampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples for batch prediction result. Under full API implementation, results are stored in shared RecordIO of AnnotatedExample protobufs, the annotations field of which is populated by XPS backend." + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntry": { + "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", + "id": "XPSBoundingBoxMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "The intersection-over-union threshold value used to compute this metrics entry.", + "format": "float", + "type": "number" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSCategoryStats": { + "description": "The data statistics of a series of CATEGORY values.", + "id": "XPSCategoryStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topCategoryStats": { + "description": "The statistics of the top 20 CATEGORY values, ordered by CategoryStats.SingleCategoryStats.count.", + "items": { + "$ref": "XPSCategoryStatsSingleCategoryStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCategoryStatsSingleCategoryStats": { + "description": "The statistics of a single CATEGORY value.", + "id": "XPSCategoryStatsSingleCategoryStats", + "properties": { + "count": { + "description": "The number of occurrences of this value in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The CATEGORY value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSClassificationEvaluationMetrics": { + "description": "Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9.", + "id": "XPSClassificationEvaluationMetrics", + "properties": { + "auPrc": { + "description": "The Area under precision recall curve metric.", + "format": "float", + "type": "number" + }, + "auRoc": { + "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", + "format": "float", + "type": "number" + }, + "baseAuPrc": { + "description": "The Area under precision recall curve metric based on priors.", + "format": "float", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the evaluation. Only set for MULTICLASS classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label." + }, + "evaluatedExamplesCount": { + "description": "The number of examples used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "logLoss": { + "description": "The Log Loss metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSColorMap": { + "description": "Map from color to display name. Will only be used by Image Segmentation for uCAIP.", + "id": "XPSColorMap", + "properties": { + "annotationSpecIdToken": { + "description": "Should be used during training.", + "type": "string" + }, + "color": { + "$ref": "Color", + "deprecated": true, + "description": "This type is deprecated in favor of the IntColor below. This is because google.type.Color represent color has a float which semantically does not reflect discrete classes/categories concept. Moreover, to handle it well we need to have some tolerance when converting to a discretized color. As such, the recommendation is to have API surface still use google.type.Color while internally IntColor is used." + }, + "displayName": { + "description": "Should be used during preprocessing.", + "type": "string" + }, + "intColor": { + "$ref": "XPSColorMapIntColor" + } + }, + "type": "object" + }, + "XPSColorMapIntColor": { + "description": "RGB color and each channel is represented by an integer.", + "id": "XPSColorMapIntColor", + "properties": { + "blue": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "green": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "red": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSColumnSpec": { + "id": "XPSColumnSpec", + "properties": { + "columnId": { + "description": "The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE.", + "format": "int32", + "type": "integer" + }, + "dataStats": { + "$ref": "XPSDataStats", + "description": "The data stats of the column. It's outputed in RefreshTablesStats and a required input for Train." + }, + "dataType": { + "$ref": "XPSDataType", + "description": "The data type of the column. It's outputed in Preprocess rpc and a required input for RefreshTablesStats and Train." + }, + "displayName": { + "description": "The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train.", + "type": "string" + }, + "forecastingMetadata": { + "$ref": "XPSColumnSpecForecastingMetadata" + }, + "topCorrelatedColumns": { + "description": "It's outputed in RefreshTablesStats, and a required input in Train.", + "items": { + "$ref": "XPSColumnSpecCorrelatedColumn" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSColumnSpecCorrelatedColumn": { + "description": "Identifies a table's column, and its correlation with the column this ColumnSpec describes.", + "id": "XPSColumnSpecCorrelatedColumn", + "properties": { + "columnId": { + "format": "int32", + "type": "integer" + }, + "correlationStats": { + "$ref": "XPSCorrelationStats" + } + }, + "type": "object" + }, + "XPSColumnSpecForecastingMetadata": { + "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", + "id": "XPSColumnSpecForecastingMetadata", + "properties": { + "columnType": { + "description": "The type of the column for FORECASTING model training purposes.", + "enum": [ + "COLUMN_TYPE_UNSPECIFIED", + "KEY", + "KEY_METADATA", + "TIME_SERIES_AVAILABLE_PAST_ONLY", + "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" + ], + "enumDescriptions": [ + "An un-set value of this enum.", + "Key columns are used to identify timeseries.", + "This column contains information describing static properties of the entities identified by the key column(s) (e.g. city's ZIP code).", + "This column contains information for the given entity, at any time poinrt, they are only available in the time series before.", + "This column contains information for the given entity is known both for the past and the sufficiently far future." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSCommonStats": { + "description": "Common statistics for a column with a specified data type.", + "id": "XPSCommonStats", + "properties": { + "distinctValueCount": { + "format": "int64", + "type": "string" + }, + "nullValueCount": { + "format": "int64", + "type": "string" + }, + "validValueCount": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfidenceMetricsEntry": { + "description": "ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16.", + "id": "XPSConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the model never return predictions with score lower than this value.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recall_at1 and precision_at1.", + "format": "float", + "type": "number" + }, + "falseNegativeCount": { + "description": "The number of ground truth labels that are not matched by a model created label.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "The number of model created labels that do not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "False Positive Rate for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "falsePositiveRateAt1": { + "description": "The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "positionThreshold": { + "description": "Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (true positive rate) for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "description": "The recall (true positive rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "trueNegativeCount": { + "description": "The number of labels that were not created by the model, but if they would, they would not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "The number of model created labels that match a ground truth label.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfusionMatrix": { + "description": "Confusion matrix of the model running the classification.", + "id": "XPSConfusionMatrix", + "properties": { + "annotationSpecIdToken": { + "description": "For the following three repeated fields, only one is intended to be set. annotation_spec_id_token is preferable to be set. ID tokens of the annotation specs used in the confusion matrix.", + "items": { + "type": "string" + }, + "type": "array" + }, + "category": { + "description": "Category (mainly for segmentation). Set only for image segmentation models. Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "row": { + "description": "Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated.", + "items": { + "$ref": "XPSConfusionMatrixRow" + }, + "type": "array" + }, + "sentimentLabel": { + "description": "Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSConfusionMatrixRow": { + "description": "A row in the confusion matrix.", + "id": "XPSConfusionMatrixRow", + "properties": { + "count": { + "description": "Same as above except intended to represent other counts (for e.g. for segmentation this is pixel count). NOTE(params): Only example_count or count is set (oneoff does not support repeated fields unless they are embedded inside another message).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "exampleCount": { + "description": "Value of the specific cell in the confusion matrix. The number of values each row has (i.e. the length of the row) is equal to the length of the annotation_spec_id_token field.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCoreMlFormat": { + "description": "A model format used for iOS mobile devices.", + "id": "XPSCoreMlFormat", + "properties": {}, + "type": "object" + }, + "XPSCorrelationStats": { + "description": "A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same.", + "id": "XPSCorrelationStats", + "properties": { + "cramersV": { + "description": "The correlation value using the Cramer's V measure.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSDataErrors": { + "description": "Different types of errors and the stats associatesd with each error.", + "id": "XPSDataErrors", + "properties": { + "count": { + "description": "Number of records having errors associated with the enum.", + "format": "int32", + "type": "integer" + }, + "errorType": { + "description": "Type of the error.", + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "UNSUPPORTED_AUDIO_FORMAT", + "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT", + "FILE_TOO_LARGE", + "MISSING_TRANSCRIPTION" + ], + "enumDescriptions": [ + "Not specified.", + "Audio format not in the formats by cloud-speech AutoML. Currently only wav and flac file formats are supported.", + "File format differnt from what is specified in the file name extension.", + "File too large. Maximum allowed size is 50 MB.", + "Transcript is missing." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDataStats": { + "description": "The data statistics of a series of values that share the same DataType.", + "id": "XPSDataStats", + "properties": { + "arrayStats": { + "$ref": "XPSArrayStats", + "description": "The statistics for ARRAY DataType." + }, + "categoryStats": { + "$ref": "XPSCategoryStats", + "description": "The statistics for CATEGORY DataType." + }, + "distinctValueCount": { + "description": "The number of distinct values.", + "format": "int64", + "type": "string" + }, + "float64Stats": { + "$ref": "XPSFloat64Stats", + "description": "The statistics for FLOAT64 DataType." + }, + "nullValueCount": { + "description": "The number of values that are null.", + "format": "int64", + "type": "string" + }, + "stringStats": { + "$ref": "XPSStringStats", + "description": "The statistics for STRING DataType." + }, + "structStats": { + "$ref": "XPSStructStats", + "description": "The statistics for STRUCT DataType." + }, + "timestampStats": { + "$ref": "XPSTimestampStats", + "description": "The statistics for TIMESTAMP DataType." + }, + "validValueCount": { + "description": "The number of values that are valid.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSDataType": { + "description": "Indicated the type of data that can be stored in a structured data entity (e.g. a table).", + "id": "XPSDataType", + "properties": { + "compatibleDataTypes": { + "description": "The highly compatible data types to this data type.", + "items": { + "$ref": "XPSDataType" + }, + "type": "array" + }, + "listElementType": { + "$ref": "XPSDataType", + "description": "If type_code == ARRAY, then `list_element_type` is the type of the elements." + }, + "nullable": { + "description": "If true, this DataType can also be `null`.", + "type": "boolean" + }, + "structType": { + "$ref": "XPSStructType", + "description": "If type_code == STRUCT, then `struct_type` provides type information for the struct's fields." + }, + "timeFormat": { + "description": "If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must be written in `strftime` syntax. If time_format is not set, then the default format as described on the field is used.", + "type": "string" + }, + "typeCode": { + "description": "Required. The TypeCode for this type.", + "enum": [ + "TYPE_CODE_UNSPECIFIED", + "FLOAT64", + "TIMESTAMP", + "STRING", + "ARRAY", + "STRUCT", + "CATEGORY" + ], + "enumDescriptions": [ + "Not specified. Should not be used.", + "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or `\"-Infinity\"`.", + "Must be between 0AD and 9999AD. Encoded as `string` according to time_format, or, if that format is not set, then in RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z).", + "Encoded as `string`.", + "Encoded as `list`, where the list elements are represented according to list_element_type.", + "Encoded as `struct`, where field values are represented according to struct_type.", + "Values of this type are not further understood by AutoML, e.g. AutoML is unable to tell the order of values (as it could with FLOAT64), or is unable to say if one value contains another (as it could with STRING). Encoded as `string` (bytes should be base64-encoded, as described in RFC 4648, section 4)." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDockerFormat": { + "description": "A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system.", + "id": "XPSDockerFormat", + "properties": { + "cpuArchitecture": { + "description": "Optional. Additional cpu information describing the requirements for the to be exported model files.", + "enum": [ + "CPU_ARCHITECTURE_UNSPECIFIED", + "CPU_ARCHITECTURE_X86_64" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "gpuArchitecture": { + "description": "Optional. Additional gpu information describing the requirements for the to be exported model files.", + "enum": [ + "GPU_ARCHITECTURE_UNSPECIFIED", + "GPU_ARCHITECTURE_NVIDIA" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSEdgeTpuTfLiteFormat": { + "description": "A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "id": "XPSEdgeTpuTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSEvaluationMetrics": { + "description": "Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18.", + "id": "XPSEvaluationMetrics", + "properties": { + "annotationSpecIdToken": { + "description": "The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead.", + "type": "string" + }, + "category": { + "description": "The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "format": "int32", + "type": "integer" + }, + "evaluatedExampleCount": { + "description": "The number of examples used to create this evaluation metrics instance.", + "format": "int32", + "type": "integer" + }, + "imageClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "imageObjectDetectionEvalMetrics": { + "$ref": "XPSImageObjectDetectionEvaluationMetrics" + }, + "imageSegmentationEvalMetrics": { + "$ref": "XPSImageSegmentationEvaluationMetrics" + }, + "label": { + "description": "The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation.", + "type": "string" + }, + "regressionEvalMetrics": { + "$ref": "XPSRegressionEvaluationMetrics" + }, + "tablesClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "tablesEvalMetrics": { + "$ref": "XPSTablesEvaluationMetrics" + }, + "textClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "textExtractionEvalMetrics": { + "$ref": "XPSTextExtractionEvaluationMetrics" + }, + "textSentimentEvalMetrics": { + "$ref": "XPSTextSentimentEvaluationMetrics" + }, + "translationEvalMetrics": { + "$ref": "XPSTranslationEvaluationMetrics" + }, + "videoActionRecognitionEvalMetrics": { + "$ref": "XPSVideoActionRecognitionEvaluationMetrics" + }, + "videoClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "videoObjectTrackingEvalMetrics": { + "$ref": "XPSVideoObjectTrackingEvaluationMetrics" + } + }, + "type": "object" + }, + "XPSEvaluationMetricsSet": { + "description": "Specifies location of model evaluation metrics.", + "id": "XPSEvaluationMetricsSet", + "properties": { + "evaluationMetrics": { + "description": "Inline EvaluationMetrics - should be relatively small. For passing large quantities of exhaustive metrics, use file_spec.", + "items": { + "$ref": "XPSEvaluationMetrics" + }, + "type": "array" + }, + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec containing evaluation metrics of a model, must point to RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics messages." + }, + "numEvaluationMetrics": { + "description": "Number of the evaluation metrics (usually one per label plus overall).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExampleSet": { + "description": "Set of examples or input sources.", + "id": "XPSExampleSet", + "properties": { + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec of the examples or input sources." + }, + "fingerprint": { + "description": "Fingerprint of the example set.", + "format": "int64", + "type": "string" + }, + "numExamples": { + "description": "Number of examples.", + "format": "int64", + "type": "string" + }, + "numInputSources": { + "description": "Number of input sources.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExportModelOutputConfig": { + "id": "XPSExportModelOutputConfig", + "properties": { + "coreMlFormat": { + "$ref": "XPSCoreMlFormat" + }, + "dockerFormat": { + "$ref": "XPSDockerFormat" + }, + "edgeTpuTfLiteFormat": { + "$ref": "XPSEdgeTpuTfLiteFormat" + }, + "exportFirebaseAuxiliaryInfo": { + "description": "For any model and format: If true, will additionally export FirebaseExportedModelInfo in a firebase.txt file.", + "type": "boolean" + }, + "outputGcrUri": { + "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "type": "string" + }, + "outputGcsUri": { + "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "type": "string" + }, + "tfJsFormat": { + "$ref": "XPSTfJsFormat" + }, + "tfLiteFormat": { + "$ref": "XPSTfLiteFormat" + }, + "tfSavedModelFormat": { + "$ref": "XPSTfSavedModelFormat" + } + }, + "type": "object" + }, + "XPSFileSpec": { + "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "id": "XPSFileSpec", + "properties": { + "directoryPath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + }, + "fileFormat": { + "enum": [ + "FILE_FORMAT_UNKNOWN", + "FILE_FORMAT_SSTABLE", + "FILE_FORMAT_TRANSLATION_RKV", + "FILE_FORMAT_RECORDIO", + "FILE_FORMAT_RAW_CSV", + "FILE_FORMAT_RAW_CAPACITOR" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "", + "Internal format for parallel text data used by Google Translate. go/rkvtools", + "", + "Only the lexicographically first file described by the file_spec contains the header line.", + "" + ], + "type": "string" + }, + "fileSpec": { + "description": "Single file path, or file pattern of format \"/path/to/file@shard_count\". E.g. /cns/cell-d/somewhere/file@2 is expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and /cns/cell-d/somewhere/file-00001-of-00002.", + "type": "string" + }, + "singleFilePath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + } + }, + "type": "object" + }, + "XPSFloat64Stats": { + "description": "The data statistics of a series of FLOAT64 values.", + "id": "XPSFloat64Stats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "histogramBuckets": { + "description": "Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being `\"-Infinity\"`, and max of the last one being `\"Infinity\"`.", + "items": { + "$ref": "XPSFloat64StatsHistogramBucket" + }, + "type": "array" + }, + "mean": { + "description": "The mean of the series.", + "format": "double", + "type": "number" + }, + "quantiles": { + "description": "Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "standardDeviation": { + "description": "The standard deviation of the series.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSFloat64StatsHistogramBucket": { + "description": "A bucket of a histogram.", + "id": "XPSFloat64StatsHistogramBucket", + "properties": { + "count": { + "description": "The number of data values that are in the bucket, i.e. are between min and max values.", + "format": "int64", + "type": "string" + }, + "max": { + "description": "The maximum value of the bucket, exclusive unless max = `\"Infinity\"`, in which case it's inclusive.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value of the bucket, inclusive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageClassificationTrainResponse": { + "id": "XPSImageClassificationTrainResponse", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Populated for AutoMl requests." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostInNodeTime": { + "description": "The actual cost to create this model. - For edge type model, the cost is expressed in node hour. - For cloud type model,the cost is expressed in compute hour. - Populated for models created before GA. To be deprecated after GA.", + "format": "google-duration", + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual training cost, expressed in node seconds. Populated for models trained in node time.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSImageExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageModelArtifactSpec": { + "description": "Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only.", + "id": "XPSImageModelArtifactSpec", + "properties": { + "checkpointArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The Tensorflow checkpoint files. e.g. Used for resumable training." + }, + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "labelGcsUri": { + "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." + }, + "tfJsBinaryGcsPrefix": { + "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "type": "string" + }, + "tfLiteMetadataGcsUri": { + "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpec": { + "description": "Serving specification for image models.", + "id": "XPSImageModelServingSpec", + "properties": { + "modelThroughputEstimation": { + "description": "Populate under uCAIP request scope.", + "items": { + "$ref": "XPSImageModelServingSpecModelThroughputEstimation" + }, + "type": "array" + }, + "nodeQps": { + "description": "An estimated value of how much traffic a node can serve. Populated for AutoMl request only.", + "format": "double", + "type": "number" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpecModelThroughputEstimation": { + "id": "XPSImageModelServingSpecModelThroughputEstimation", + "properties": { + "computeEngineAcceleratorType": { + "enum": [ + "UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_L4", + "NVIDIA_H100_80GB", + "TPU_V2", + "TPU_V3", + "TPU_V4_POD", + "TPU_V5_LITEPOD" + ], + "enumDescriptions": [ + "", + "Nvidia Tesla K80 GPU.", + "Nvidia Tesla P100 GPU.", + "Nvidia Tesla V100 GPU.", + "Nvidia Tesla P4 GPU.", + "Nvidia Tesla T4 GPU.", + "Nvidia Tesla A100 GPU.", + "Nvidia A100 80GB GPU.", + "Nvidia L4 GPU.", + "Nvidia H100 80Gb GPU.", + "TPU v2 (JellyFish).", + "TPU v3 (DragonFish).", + "TPU_v4 (PufferFish).", + "TPU v5 Lite Pods." + ], + "type": "string" + }, + "latencyInMilliseconds": { + "description": "Estimated latency.", + "format": "double", + "type": "number" + }, + "nodeQps": { + "description": "The approximate qps a deployed node can serve.", + "format": "double", + "type": "number" + }, + "servomaticPartitionType": { + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionEvaluationMetrics": { + "description": "Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes.", + "id": "XPSImageObjectDetectionEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingBoxCount": { + "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionModelSpec": { + "id": "XPSImageObjectDetectionModelSpec", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec" + }, + "maxBoundingBoxCount": { + "description": "Max number of bounding box.", + "format": "int64", + "type": "string" + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetrics": { + "description": "Model evaluation metrics for image segmentation problems. Next tag: 4.", + "id": "XPSImageSegmentationEvaluationMetrics", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the per confidence_threshold evaluation. Pixel counts are set here. Only set for model level evaluation, not for evaluation per label." + }, + "diceScoreCoefficient": { + "description": "DSC or the F1 score: The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "iouScore": { + "description": "IOU score.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageSegmentationTrainResponse": { + "id": "XPSImageSegmentationTrainResponse", + "properties": { + "colorMaps": { + "description": "Color map of the model.", + "items": { + "$ref": "XPSColorMap" + }, + "type": "array" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "NOTE: These fields are not used/needed in EAP but will be set later." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope. Model artifact spec stores and model gcs pathes and related metadata" + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSIntegratedGradientsAttribution": { + "deprecated": true, + "description": "An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365", + "id": "XPSIntegratedGradientsAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSMetricEntry": { + "id": "XPSMetricEntry", + "properties": { + "argentumMetricId": { + "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", + "type": "string" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "systemLabels": { + "description": "Billing system labels for this (metric, value) pair.", + "items": { + "$ref": "XPSMetricEntryLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSMetricEntryLabel": { + "id": "XPSMetricEntryLabel", + "properties": { + "labelName": { + "description": "The name of the label.", + "type": "string" + }, + "labelValue": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "XPSModelArtifactItem": { + "description": "A single model artifact item.", + "id": "XPSModelArtifactItem", + "properties": { + "artifactFormat": { + "description": "The model artifact format.", + "enum": [ + "ARTIFACT_FORMAT_UNSPECIFIED", + "TF_CHECKPOINT", + "TF_SAVED_MODEL", + "TF_LITE", + "EDGE_TPU_TF_LITE", + "TF_JS", + "CORE_ML" + ], + "enumDescriptions": [ + "Should not be used.", + "The Tensorflow checkpoints. See https://www.tensorflow.org/guide/checkpoint.", + "The Tensorflow SavedModel binary.", + "Model artifact in generic TensorFlow Lite (.tflite) format. See https://www.tensorflow.org/lite.", + "Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "Used for iOS mobile devices in (.mlmodel) format. See https://developer.apple.com/documentation/coreml" + ], + "type": "string" + }, + "gcsUri": { + "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "type": "string" + } + }, + "type": "object" + }, + "XPSPreprocessResponse": { + "description": "Next ID: 8", + "id": "XPSPreprocessResponse", + "properties": { + "outputExampleSet": { + "$ref": "XPSExampleSet", + "description": "Preprocessed examples, that are to be imported into AutoML storage. This should point to RecordIO file(s) of PreprocessedExample messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data." + }, + "speechPreprocessResp": { + "$ref": "XPSSpeechPreprocessResponse" + }, + "tablesPreprocessResponse": { + "$ref": "XPSTablesPreprocessResponse" + }, + "translationPreprocessResp": { + "$ref": "XPSTranslationPreprocessResponse" + } + }, + "type": "object" + }, + "XPSRegressionEvaluationMetrics": { + "description": "Model evaluation metrics for regression problems. It can be used for Tables.", + "id": "XPSRegressionEvaluationMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean Absolute Error (MAE).", + "format": "float", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error. Only set if all ground truth values are positive.", + "format": "float", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "float", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root Mean Squared Error (RMSE).", + "format": "float", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSRegressionMetricsEntry": { + "description": "A pair of actual \u0026 observed values for the model being evaluated.", + "id": "XPSRegressionMetricsEntry", + "properties": { + "predictedValue": { + "description": "The observed value for a row in the dataset.", + "format": "float", + "type": "number" + }, + "trueValue": { + "description": "The actual target value for a row in the dataset.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSReportingMetrics": { + "id": "XPSReportingMetrics", + "properties": { + "effectiveTrainingDuration": { + "deprecated": true, + "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", + "format": "google-duration", + "type": "string" + }, + "metricEntries": { + "description": "One entry per metric name. The values must be aggregated per metric name.", + "items": { + "$ref": "XPSMetricEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadata": { + "deprecated": true, + "id": "XPSResponseExplanationMetadata", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataInputMetadata" + }, + "description": "Metadata of the input.", + "type": "object" + }, + "outputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataOutputMetadata" + }, + "description": "Metadata of the output.", + "type": "object" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataInputMetadata": { + "description": "Metadata of the input of a feature.", + "id": "XPSResponseExplanationMetadataInputMetadata", + "properties": { + "inputTensorName": { + "description": "Name of the input tensor for this model. Only needed in train response.", + "type": "string" + }, + "modality": { + "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.", + "enum": [ + "MODALITY_UNSPECIFIED", + "NUMERIC", + "IMAGE", + "CATEGORICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "visualizationConfig": { + "$ref": "XPSVisualization", + "description": "Visualization configurations for image explanation." + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataOutputMetadata": { + "description": "Metadata of the prediction output to be explained.", + "id": "XPSResponseExplanationMetadataOutputMetadata", + "properties": { + "outputTensorName": { + "description": "Name of the output tensor. Only needed in train response.", + "type": "string" + } + }, + "type": "object" + }, + "XPSResponseExplanationParameters": { + "deprecated": true, + "id": "XPSResponseExplanationParameters", + "properties": { + "integratedGradientsAttribution": { + "$ref": "XPSIntegratedGradientsAttribution", + "description": "An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365" + }, + "xraiAttribution": { + "$ref": "XPSXraiAttribution", + "description": "An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead." + } + }, + "type": "object" + }, + "XPSResponseExplanationSpec": { + "deprecated": true, + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "id": "XPSResponseExplanationSpec", + "properties": { + "explanationType": { + "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "type": "string" + }, + "metadata": { + "$ref": "XPSResponseExplanationMetadata", + "description": "Metadata describing the Model's input and output for explanation." + }, + "parameters": { + "$ref": "XPSResponseExplanationParameters", + "description": "Parameters that configure explaining of the Model's predictions." + } + }, + "type": "object" + }, + "XPSRow": { + "id": "XPSRow", + "properties": { + "columnIds": { + "description": "The ids of the columns. Note: The below `values` field must match order of this field, if this field is set.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "values": { + "description": "The values of the row cells, given in the same order as the column_ids. If column_ids is not set, then in the same order as the input_feature_column_ids in TablesModelMetadata.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetrics": { + "id": "XPSSpeechEvaluationMetrics", + "properties": { + "subModelEvaluationMetrics": { + "description": "Evaluation metrics for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetricsSubModelEvaluationMetric": { + "id": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + }, + "numDeletions": { + "format": "int32", + "type": "integer" + }, + "numInsertions": { + "format": "int32", + "type": "integer" + }, + "numSubstitutions": { + "format": "int32", + "type": "integer" + }, + "numUtterances": { + "description": "Number of utterances used in the wer computation.", + "format": "int32", + "type": "integer" + }, + "numWords": { + "description": "Number of words over which the word error rate was computed.", + "format": "int32", + "type": "integer" + }, + "sentenceAccuracy": { + "description": "Below fields are used for debugging purposes", + "format": "double", + "type": "number" + }, + "wer": { + "description": "Word error rate (standard error metric used for speech recognition).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSSpeechModelSpec": { + "id": "XPSSpeechModelSpec", + "properties": { + "datasetId": { + "description": "Required for speech xps backend. Speech xps has to use dataset_id and model_id as the primary key in db so that speech API can query the db directly.", + "format": "int64", + "type": "string" + }, + "language": { + "type": "string" + }, + "subModelSpecs": { + "description": "Model specs for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechModelSpecSubModelSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechModelSpecSubModelSpec": { + "id": "XPSSpeechModelSpecSubModelSpec", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "clientId": { + "description": "In S3, Recognition ClientContextId.client_id", + "type": "string" + }, + "contextId": { + "description": "In S3, Recognition ClientContextId.context_id", + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + } + }, + "type": "object" + }, + "XPSSpeechPreprocessResponse": { + "id": "XPSSpeechPreprocessResponse", + "properties": { + "cnsTestDataPath": { + "description": "Location od shards of sstables (test data) of DataUtterance protos.", + "type": "string" + }, + "cnsTrainDataPath": { + "description": "Location of shards of sstables (training data) of DataUtterance protos.", + "type": "string" + }, + "prebuiltModelEvaluationMetrics": { + "$ref": "XPSSpeechEvaluationMetrics", + "description": "The metrics for prebuilt speech models. They are included here because there is no prebuilt speech models stored in the AutoML." + }, + "speechPreprocessStats": { + "$ref": "XPSSpeechPreprocessStats", + "description": "Stats associated with the data." + } + }, + "type": "object" + }, + "XPSSpeechPreprocessStats": { + "id": "XPSSpeechPreprocessStats", + "properties": { + "dataErrors": { + "description": "Different types of data errors and the counts associated with them.", + "items": { + "$ref": "XPSDataErrors" + }, + "type": "array" + }, + "numHumanLabeledExamples": { + "description": "The number of rows marked HUMAN_LABELLED", + "format": "int32", + "type": "integer" + }, + "numLogsExamples": { + "description": "The number of samples found in the previously recorded logs data.", + "format": "int32", + "type": "integer" + }, + "numMachineTranscribedExamples": { + "description": "The number of rows marked as MACHINE_TRANSCRIBED", + "format": "int32", + "type": "integer" + }, + "testExamplesCount": { + "description": "The number of examples labelled as TEST by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "testSentencesCount": { + "description": "The number of sentences in the test data set.", + "format": "int32", + "type": "integer" + }, + "testWordsCount": { + "description": "The number of words in the test data set.", + "format": "int32", + "type": "integer" + }, + "trainExamplesCount": { + "description": "The number of examples labeled as TRAIN by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "trainSentencesCount": { + "description": "The number of sentences in the training data set.", + "format": "int32", + "type": "integer" + }, + "trainWordsCount": { + "description": "The number of words in the training data set.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSStringStats": { + "description": "The data statistics of a series of STRING values.", + "id": "XPSStringStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topUnigramStats": { + "description": "The statistics of the top 20 unigrams, ordered by StringStats.UnigramStats.count.", + "items": { + "$ref": "XPSStringStatsUnigramStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSStringStatsUnigramStats": { + "description": "The statistics of a unigram.", + "id": "XPSStringStatsUnigramStats", + "properties": { + "count": { + "description": "The number of occurrences of this unigram in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The unigram.", + "type": "string" + } + }, + "type": "object" + }, + "XPSStructStats": { + "description": "The data statistics of a series of STRUCT values.", + "id": "XPSStructStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "fieldStats": { + "additionalProperties": { + "$ref": "XPSDataStats" + }, + "description": "Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs.", + "type": "object" + } + }, + "type": "object" + }, + "XPSStructType": { + "description": "`StructType` defines the DataType-s of a STRUCT type.", + "id": "XPSStructType", + "properties": { + "fields": { + "additionalProperties": { + "$ref": "XPSDataType" + }, + "description": "Unordered map of struct field names to their data types.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTableSpec": { + "id": "XPSTableSpec", + "properties": { + "columnSpecs": { + "additionalProperties": { + "$ref": "XPSColumnSpec" + }, + "description": "Mapping from column id to column spec.", + "type": "object" + }, + "importedDataSizeInBytes": { + "description": "The total size of imported data of the table.", + "format": "int64", + "type": "string" + }, + "rowCount": { + "description": "The number of rows in the table.", + "format": "int64", + "type": "string" + }, + "timeColumnId": { + "description": "The id of the time column.", + "format": "int32", + "type": "integer" + }, + "validRowCount": { + "description": "The number of valid rows.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetrics": { + "description": "Metrics for Tables classification problems.", + "id": "XPSTablesClassificationMetrics", + "properties": { + "curveMetrics": { + "description": "Metrics building a curve.", + "items": { + "$ref": "XPSTablesClassificationMetricsCurveMetrics" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetricsCurveMetrics": { + "description": "Metrics curve data point for a single value.", + "id": "XPSTablesClassificationMetricsCurveMetrics", + "properties": { + "aucPr": { + "description": "The area under the precision-recall curve.", + "format": "double", + "type": "number" + }, + "aucRoc": { + "description": "The area under receiver operating characteristic curve.", + "format": "double", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve and ROC curve can be derived from them.", + "items": { + "$ref": "XPSTablesConfidenceMetricsEntry" + }, + "type": "array" + }, + "logLoss": { + "description": "The Log loss metric.", + "format": "double", + "type": "number" + }, + "positionThreshold": { + "description": "The position threshold value used to compute the metrics.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The CATEGORY row value (for ARRAY unnested) the curve metrics are for.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSTablesConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision. (2 * precision * recall) / (precision + recall)", + "format": "double", + "type": "number" + }, + "falseNegativeCount": { + "description": "False negative count.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "False positive count.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "FPR = #false positives / (#false positives + #true negatives)", + "format": "double", + "type": "number" + }, + "precision": { + "description": "Precision = #true positives / (#true positives + #false positives).", + "format": "double", + "type": "number" + }, + "recall": { + "description": "Recall = #true positives / (#true positives + #false negatives).", + "format": "double", + "type": "number" + }, + "trueNegativeCount": { + "description": "True negative count.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "True positive count.", + "format": "int64", + "type": "string" + }, + "truePositiveRate": { + "description": "TPR = #true positives / (#true positives + #false negatvies)", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesDatasetMetadata": { + "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "id": "XPSTablesDatasetMetadata", + "properties": { + "mlUseColumnId": { + "description": "Id the column to split the table.", + "format": "int32", + "type": "integer" + }, + "primaryTableSpec": { + "$ref": "XPSTableSpec", + "description": "Primary table." + }, + "targetColumnCorrelations": { + "additionalProperties": { + "$ref": "XPSCorrelationStats" + }, + "description": "(the column id : its CorrelationStats with target column).", + "type": "object" + }, + "targetColumnId": { + "description": "Id of the primary table column that should be used as the training label.", + "format": "int32", + "type": "integer" + }, + "weightColumnId": { + "description": "Id of the primary table column that should be used as the weight column.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSTablesEvaluationMetrics": { + "id": "XPSTablesEvaluationMetrics", + "properties": { + "classificationMetrics": { + "$ref": "XPSTablesClassificationMetrics", + "description": "Classification metrics." + }, + "regressionMetrics": { + "$ref": "XPSTablesRegressionMetrics", + "description": "Regression metrics." + } + }, + "type": "object" + }, + "XPSTablesModelColumnInfo": { + "description": "An information specific to given column and Tables Model, in context of the Model and the predictions created by it.", + "id": "XPSTablesModelColumnInfo", + "properties": { + "columnId": { + "description": "The ID of the column.", + "format": "int32", + "type": "integer" + }, + "featureImportance": { + "description": "When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesModelStructure": { + "description": "A description of Tables model structure.", + "id": "XPSTablesModelStructure", + "properties": { + "modelParameters": { + "description": "A list of models.", + "items": { + "$ref": "XPSTablesModelStructureModelParameters" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParameters": { + "description": "Model hyper-parameters for a model.", + "id": "XPSTablesModelStructureModelParameters", + "properties": { + "hyperparameters": { + "items": { + "$ref": "XPSTablesModelStructureModelParametersParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParametersParameter": { + "id": "XPSTablesModelStructureModelParametersParameter", + "properties": { + "floatValue": { + "description": "Float type parameter value.", + "format": "double", + "type": "number" + }, + "intValue": { + "description": "Integer type parameter value.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Parameter name.", + "type": "string" + }, + "stringValue": { + "description": "String type parameter value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesPreprocessResponse": { + "id": "XPSTablesPreprocessResponse", + "properties": { + "tablesDatasetMetadata": { + "$ref": "XPSTablesDatasetMetadata", + "description": "The table/column id, column_name and the DataTypes of the columns will be populated." + } + }, + "type": "object" + }, + "XPSTablesRegressionMetrics": { + "description": "Metrics for Tables regression problems.", + "id": "XPSTablesRegressionMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean absolute error.", + "format": "double", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error, only set if all of the target column's values are positive.", + "format": "double", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "double", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root mean squared error.", + "format": "double", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesTrainResponse": { + "id": "XPSTablesTrainResponse", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure" + }, + "predictionSampleRows": { + "description": "Sample rows from the dataset this model was trained.", + "items": { + "$ref": "XPSRow" + }, + "type": "array" + }, + "tablesModelColumnInfo": { + "description": "Output only. Auxiliary information for each of the input_feature_column_specs, with respect to this particular model.", + "items": { + "$ref": "XPSTablesModelColumnInfo" + }, + "type": "array" + }, + "trainCostMilliNodeHours": { + "description": "The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesTrainingOperationMetadata": { + "id": "XPSTablesTrainingOperationMetadata", + "properties": { + "createModelStage": { + "description": "Current stage of creating model.", + "enum": [ + "CREATE_MODEL_STAGE_UNSPECIFIED", + "DATA_PREPROCESSING", + "TRAINING", + "EVALUATING", + "MODEL_POST_PROCESSING" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Prepare the model training pipeline and run data processing.", + "Training model.", + "Run evaluation.", + "Finalizing model training pipeline." + ], + "type": "string" + }, + "optimizationObjective": { + "description": "The optimization objective for model.", + "type": "string" + }, + "topTrials": { + "description": "This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure.", + "items": { + "$ref": "XPSTuningTrial" + }, + "type": "array" + }, + "trainBudgetMilliNodeHours": { + "description": "Creating model budget.", + "format": "int64", + "type": "string" + }, + "trainingObjectivePoints": { + "description": "This field records the training objective value with respect to time, giving insight into how the model architecture search is performing as training time elapses.", + "items": { + "$ref": "XPSTrainingObjectivePoint" + }, + "type": "array" + }, + "trainingStartTime": { + "description": "Timestamp when training process starts.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextComponentModel": { + "description": "Component model. Next ID: 10", + "id": "XPSTextComponentModel", + "properties": { + "batchPredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold batch prediction model.", + "type": "string" + }, + "onlinePredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold online prediction model.", + "type": "string" + }, + "partition": { + "description": "The partition where the model is deployed. Populated by uCAIP BE as part of online PredictRequest.", + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud Ai Platform API." + }, + "servoModelName": { + "description": "The name of servo model. Populated by uCAIP BE as part of online PredictRequest.", + "type": "string" + }, + "submodelName": { + "description": "The name of the trained NL submodel.", + "type": "string" + }, + "submodelType": { + "description": "The type of trained NL submodel", + "enum": [ + "TEXT_MODEL_TYPE_UNSPECIFIED", + "TEXT_MODEL_TYPE_DEFAULT", + "TEXT_MODEL_TYPE_META_ARCHITECT", + "TEXT_MODEL_TYPE_ATC", + "TEXT_MODEL_TYPE_CLARA2", + "TEXT_MODEL_TYPE_CHATBASE", + "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING", + "TEXT_MODEL_TYPE_TEXT_EXTRACTION", + "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION", + "TEXT_MODEL_TYPE_COMPOSITE", + "TEXT_MODEL_TYPE_ALL_MODELS", + "TEXT_MODEL_TYPE_BERT", + "TEXT_MODEL_TYPE_ENC_PALM" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "Model type for entity extraction.", + "Model type for relationship extraction.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", + "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", + "Model type for EncPaLM." + ], + "type": "string" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + }, + "versionNumber": { + "description": "The servomatic model version number. Populated by uCAIP BE as part of online PredictRequest.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextExtractionEvaluationMetrics": { + "id": "XPSTextExtractionEvaluationMetrics", + "properties": { + "bestF1ConfidenceMetrics": { + "$ref": "XPSConfidenceMetricsEntry", + "deprecated": true, + "description": "Values are at the highest F1 score on the precision-recall curve. Only confidence_threshold, recall, precision, and f1_score will be set." + }, + "confidenceMetricsEntries": { + "description": "If the enclosing EvaluationMetrics.label is empty, confidence_metrics_entries is an evaluation of the entire model across all labels. If the enclosing EvaluationMetrics.label is set, confidence_metrics_entries applies to that label.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the model, at the default confidence threshold (0.0). Only set for whole-model evaluation, not for evaluation per label." + }, + "perLabelConfidenceMetrics": { + "additionalProperties": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "deprecated": true, + "description": "Only recall, precision, and f1_score will be set.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTextSentimentEvaluationMetrics": { + "description": "Model evaluation metrics for text sentiment problems.", + "id": "XPSTextSentimentEvaluationMetrics", + "properties": { + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Output only. Confusion matrix of the evaluation. Only set for the overall model evaluation, not for evaluation of a single annotation spec." + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "linearKappa": { + "description": "Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanAbsoluteError": { + "description": "Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanSquaredError": { + "description": "Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision.", + "format": "float", + "type": "number" + }, + "quadraticKappa": { + "description": "Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTextToSpeechTrainResponse": { + "description": "TextToSpeech train response", + "id": "XPSTextToSpeechTrainResponse", + "properties": {}, + "type": "object" + }, + "XPSTextTrainResponse": { + "id": "XPSTextTrainResponse", + "properties": { + "componentModel": { + "description": "Component submodels.", + "items": { + "$ref": "XPSTextComponentModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTfJsFormat": { + "description": "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "id": "XPSTfJsFormat", + "properties": {}, + "type": "object" + }, + "XPSTfLiteFormat": { + "description": "LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite.", + "id": "XPSTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSTfSavedModelFormat": { + "description": "A tensorflow model format in SavedModel format.", + "id": "XPSTfSavedModelFormat", + "properties": {}, + "type": "object" + }, + "XPSTimestampStats": { + "description": "The data statistics of a series of TIMESTAMP values.", + "id": "XPSTimestampStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "granularStats": { + "additionalProperties": { + "$ref": "XPSTimestampStatsGranularStats" + }, + "description": "The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated).", + "type": "object" + }, + "medianTimestampNanos": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTimestampStatsGranularStats": { + "description": "Stats split by a defined in context granularity.", + "id": "XPSTimestampStatsGranularStats", + "properties": { + "buckets": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map from granularity key to example count for that key. E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May).", + "type": "object" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntry": { + "description": "Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6.", + "id": "XPSTrackMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them.", + "items": { + "$ref": "XPSTrackMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.", + "format": "float", + "type": "number" + }, + "meanBoundingBoxIou": { + "description": "Output only. The mean bounding box iou over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanMismatchRate": { + "description": "Output only. The mean mismatch rate over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanTrackingAveragePrecision": { + "description": "Output only. The mean average precision over all confidence thresholds.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold. Next tag: 6.", + "id": "XPSTrackMetricsEntryConfidenceMetricsEntry", + "properties": { + "boundingBoxIou": { + "description": "Output only. Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold).", + "format": "float", + "type": "number" + }, + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "mismatchRate": { + "description": "Output only. Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", + "format": "float", + "type": "number" + }, + "trackingPrecision": { + "description": "Output only. Tracking precision.", + "format": "float", + "type": "number" + }, + "trackingRecall": { + "description": "Output only. Tracking recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrainResponse": { + "description": "Next ID: 18", + "id": "XPSTrainResponse", + "properties": { + "deployedModelSizeBytes": { + "description": "Estimated model size in bytes once deployed.", + "format": "int64", + "type": "string" + }, + "errorAnalysisConfigs": { + "description": "Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample).", + "items": { + "$ref": "XPSVisionErrorAnalysisConfig" + }, + "type": "array" + }, + "evaluatedExampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted." + }, + "evaluationMetricsSet": { + "$ref": "XPSEvaluationMetricsSet", + "description": "The trained model evaluation metrics. This can be optionally returned." + }, + "explanationConfigs": { + "deprecated": true, + "description": "VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request.", + "items": { + "$ref": "XPSResponseExplanationSpec" + }, + "type": "array" + }, + "imageClassificationTrainResp": { + "$ref": "XPSImageClassificationTrainResponse" + }, + "imageObjectDetectionTrainResp": { + "$ref": "XPSImageObjectDetectionModelSpec" + }, + "imageSegmentationTrainResp": { + "$ref": "XPSImageSegmentationTrainResponse" + }, + "modelToken": { + "description": "Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.", + "format": "byte", + "type": "string" + }, + "speechTrainResp": { + "$ref": "XPSSpeechModelSpec" + }, + "tablesTrainResp": { + "$ref": "XPSTablesTrainResponse" + }, + "textToSpeechTrainResp": { + "$ref": "XPSTextToSpeechTrainResponse" + }, + "textTrainResp": { + "$ref": "XPSTextTrainResponse", + "description": "Will only be needed for uCAIP from Beta." + }, + "translationTrainResp": { + "$ref": "XPSTranslationTrainResponse" + }, + "videoActionRecognitionTrainResp": { + "$ref": "XPSVideoActionRecognitionTrainResponse" + }, + "videoClassificationTrainResp": { + "$ref": "XPSVideoClassificationTrainResponse" + }, + "videoObjectTrackingTrainResp": { + "$ref": "XPSVideoObjectTrackingTrainResponse" + } + }, + "type": "object" + }, + "XPSTrainingObjectivePoint": { + "id": "XPSTrainingObjectivePoint", + "properties": { + "createTime": { + "description": "The time at which this point was recorded.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "The objective value when this point was recorded.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationEvaluationMetrics": { + "description": "Evaluation metrics for the dataset.", + "id": "XPSTranslationEvaluationMetrics", + "properties": { + "baseBleuScore": { + "description": "BLEU score for base model.", + "format": "double", + "type": "number" + }, + "bleuScore": { + "description": "BLEU score.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationPreprocessResponse": { + "description": "Translation preprocess response.", + "id": "XPSTranslationPreprocessResponse", + "properties": { + "parsedExampleCount": { + "description": "Total example count parsed.", + "format": "int64", + "type": "string" + }, + "validExampleCount": { + "description": "Total valid example count.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTranslationTrainResponse": { + "description": "Train response for translation.", + "id": "XPSTranslationTrainResponse", + "properties": { + "modelType": { + "description": "Type of the model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "LEGACY", + "CURRENT" + ], + "enumDescriptions": [ + "Default", + "Legacy model. Will be deprecated.", + "Current model." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSTuningTrial": { + "description": "Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users.", + "id": "XPSTuningTrial", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure", + "description": "Model parameters for the trial." + }, + "trainingObjectivePoint": { + "$ref": "XPSTrainingObjectivePoint", + "description": "The optimization objective evaluation of the eval split data." + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntry": { + "description": "The Evaluation metrics entry given a specific precision_window_length.", + "id": "XPSVideoActionMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSVideoActionMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + }, + "precisionWindowLength": { + "description": "This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSVideoActionMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionEvaluationMetrics": { + "description": "Model evaluation metrics for video action recognition.", + "id": "XPSVideoActionRecognitionEvaluationMetrics", + "properties": { + "evaluatedActionCount": { + "description": "Output only. The number of ground truth actions used to create this evaluation.", + "format": "int32", + "type": "integer" + }, + "videoActionMetricsEntries": { + "description": "Output only. The metric entries for precision window lengths: 1s,2s,3s,4s, 5s.", + "items": { + "$ref": "XPSVideoActionMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionTrainResponse": { + "id": "XPSVideoActionRecognitionTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoBatchPredictOperationMetadata": { + "id": "XPSVideoBatchPredictOperationMetadata", + "properties": { + "outputExamples": { + "description": "All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoClassificationTrainResponse": { + "id": "XPSVideoClassificationTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSVideoExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoModelArtifactSpec": { + "id": "XPSVideoModelArtifactSpec", + "properties": { + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. batch predict) via public Cloud AI Platform API." + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingEvaluationMetrics": { + "description": "Model evaluation metrics for ObjectTracking problems. Next tag: 10.", + "id": "XPSVideoObjectTrackingEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "Output only. The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "Output only. The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingboxCount": { + "description": "The number of bounding boxes used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedFrameCount": { + "description": "The number of video frames used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedTrackCount": { + "description": "The number of tracks used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "trackMeanAveragePrecision": { + "description": "Output only. The single metric for tracks accuracy evaluation: the mean_average_precision averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanBoundingBoxIou": { + "description": "Output only. The single metric for tracks bounding box iou evaluation: the mean_bounding_box_iou averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanMismatchRate": { + "description": "Output only. The single metric for tracking consistency evaluation: the mean_mismatch_rate averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMetricsEntries": { + "description": "Output only. The tracks match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSTrackMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingTrainResponse": { + "id": "XPSVideoObjectTrackingTrainResponse", + "properties": { + "exportModelSpec": { + "$ref": "XPSVideoExportModelSpec", + "description": "Populated for AutoML request only." + }, + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoTrainingOperationMetadata": { + "id": "XPSVideoTrainingOperationMetadata", + "properties": { + "trainCostMilliNodeHour": { + "description": "This is an estimation of the node hours necessary for training a model, expressed in milli node hours (i.e. 1,000 value in this field means 1 node hour). A node hour represents the time a virtual machine spends running your training job. The cost of one node running for one hour is a node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionErrorAnalysisConfig": { + "description": "The vision model error analysis configuration. Next tag: 3", + "id": "XPSVisionErrorAnalysisConfig", + "properties": { + "exampleCount": { + "description": "The number of query examples in error analysis.", + "format": "int32", + "type": "integer" + }, + "queryType": { + "description": "The query type used in retrieval. The enum values are frozen in the foreseeable future.", + "enum": [ + "QUERY_TYPE_UNSPECIFIED", + "QUERY_TYPE_ALL_SIMILAR", + "QUERY_TYPE_SAME_CLASS_SIMILAR", + "QUERY_TYPE_SAME_CLASS_DISSIMILAR" + ], + "enumDescriptions": [ + "Unspecified query type for model error analysis.", + "Query similar samples across all classes in the dataset.", + "Query similar samples from the same class of the input sample.", + "Query dissimilar samples from the same class of the input sample." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionTrainingOperationMetadata": { + "deprecated": true, + "id": "XPSVisionTrainingOperationMetadata", + "properties": { + "explanationUsage": { + "$ref": "InfraUsage", + "description": "Aggregated infra usage within certain time period, for billing report purpose if XAI is enable in training request." + } + }, + "type": "object" + }, + "XPSVisualization": { + "deprecated": true, + "description": "Visualization configurations for image explanation.", + "id": "XPSVisualization", + "properties": { + "clipPercentLowerbound": { + "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.", + "format": "float", + "type": "number" + }, + "clipPercentUpperbound": { + "description": "Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.", + "format": "float", + "type": "number" + }, + "colorMap": { + "description": "The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.", + "enum": [ + "COLOR_MAP_UNSPECIFIED", + "PINK_GREEN", + "VIRIDIS", + "RED", + "GREEN", + "RED_GREEN", + "PINK_WHITE_GREEN" + ], + "enumDescriptions": [ + "Should not be used.", + "Positive: green. Negative: pink.", + "Viridis color map: A perceptually uniform color mapping which is easier to see by those with colorblindness and progresses from yellow to green to blue. Positive: yellow. Negative: blue.", + "Positive: red. Negative: red.", + "Positive: green. Negative: green.", + "Positive: green. Negative: red.", + "PiYG palette." + ], + "type": "string" + }, + "overlayType": { + "description": "How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.", + "enum": [ + "OVERLAY_TYPE_UNSPECIFIED", + "NONE", + "ORIGINAL", + "GRAYSCALE", + "MASK_BLACK" + ], + "enumDescriptions": [ + "Default value. This is the same as NONE.", + "No overlay.", + "The attributions are shown on top of the original image.", + "The attributions are shown on top of grayscaled version of the original image.", + "The attributions are used as a mask to reveal predictive parts of the image and hide the un-predictive parts." + ], + "type": "string" + }, + "polarity": { + "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", + "enum": [ + "POLARITY_UNSPECIFIED", + "POSITIVE", + "NEGATIVE", + "BOTH" + ], + "enumDescriptions": [ + "Default value. This is the same as POSITIVE.", + "Highlights the pixels/outlines that were most influential to the model's prediction.", + "Setting polarity to negative highlights areas that does not lead to the models's current prediction.", + "Shows both positive and negative attributions." + ], + "type": "string" + }, + "type": { + "description": "Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXELS", + "OUTLINES" + ], + "enumDescriptions": [ + "Should not be used.", + "Shows which pixel contributed to the image prediction.", + "Shows which region contributed to the image prediction by outlining the region." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSXpsOperationMetadata": { + "id": "XPSXpsOperationMetadata", + "properties": { + "exampleCount": { + "description": "Optional. XPS server can opt to provide example count of the long running operation (e.g. training, data importing, batch prediction).", + "format": "int64", + "type": "string" + }, + "reportingMetrics": { + "$ref": "XPSReportingMetrics", + "description": "Metrics for the operation. By the time the operation is terminated (whether succeeded or failed) as returned from XPS, AutoML BE assumes the metrics are finalized. AutoML BE transparently posts the metrics to Chemist if it's not empty, regardless of the response content or error type. If user is supposed to be charged in case of cancellation/error, this field should be set. In the case where the type of LRO doesn't require any billing, this field should be left unset." + }, + "tablesTrainingOperationMetadata": { + "$ref": "XPSTablesTrainingOperationMetadata" + }, + "videoBatchPredictOperationMetadata": { + "$ref": "XPSVideoBatchPredictOperationMetadata" + }, + "videoTrainingOperationMetadata": { + "$ref": "XPSVideoTrainingOperationMetadata" + }, + "visionTrainingOperationMetadata": { + "$ref": "XPSVisionTrainingOperationMetadata" + } + }, + "type": "object" + }, + "XPSXraiAttribution": { + "deprecated": true, + "description": "An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE).", + "id": "XPSXraiAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/language/v1beta2/language-gen.go b/language/v1beta2/language-gen.go index afd4d4ba799..79e7382d43a 100644 --- a/language/v1beta2/language-gen.go +++ b/language/v1beta2/language-gen.go @@ -540,7 +540,7 @@ type AnnotateTextRequest struct { EncodingType string `json:"encodingType,omitempty"` // Features: Required. The enabled features. - Features *Features `json:"features,omitempty"` + Features *AnnotateTextRequestFeatures `json:"features,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with @@ -565,6 +565,63 @@ func (s *AnnotateTextRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AnnotateTextRequestFeatures: All available features for sentiment, +// syntax, and semantic analysis. Setting each one to true will enable +// that specific analysis for the input. Next ID: 12 +type AnnotateTextRequestFeatures struct { + // ClassificationModelOptions: Optional. The model options to use for + // classification. Defaults to v1 options if not specified. Only used if + // `classify_text` is set to true. + ClassificationModelOptions *ClassificationModelOptions `json:"classificationModelOptions,omitempty"` + + // ClassifyText: Classify the full document into categories. If this is + // true, the API will use the default model which classifies into a + // predefined taxonomy + // (https://cloud.google.com/natural-language/docs/categories). + ClassifyText bool `json:"classifyText,omitempty"` + + // ExtractDocumentSentiment: Extract document-level sentiment. + ExtractDocumentSentiment bool `json:"extractDocumentSentiment,omitempty"` + + // ExtractEntities: Extract entities. + ExtractEntities bool `json:"extractEntities,omitempty"` + + // ExtractEntitySentiment: Extract entities and their associated + // sentiment. + ExtractEntitySentiment bool `json:"extractEntitySentiment,omitempty"` + + // ExtractSyntax: Extract syntax information. + ExtractSyntax bool `json:"extractSyntax,omitempty"` + + // ModerateText: Moderate the document for harmful and sensitive + // categories. + ModerateText bool `json:"moderateText,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ClassificationModelOptions") 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. + // "ClassificationModelOptions") 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 *AnnotateTextRequestFeatures) MarshalJSON() ([]byte, error) { + type NoMethod AnnotateTextRequestFeatures + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AnnotateTextResponse: The text annotations response message. type AnnotateTextResponse struct { // Categories: Categories identified in the input document. @@ -680,12 +737,12 @@ type ClassificationModelOptions struct { // V1Model: Setting this field will use the V1 model and V1 content // categories version. The V1 model is a legacy model; support for this // will be discontinued in the future. - V1Model *V1Model `json:"v1Model,omitempty"` + V1Model *ClassificationModelOptionsV1Model `json:"v1Model,omitempty"` // V2Model: Setting this field will use the V2 model with the // appropriate content categories version. The V2 model is a better // performing model. - V2Model *V2Model `json:"v2Model,omitempty"` + V2Model *ClassificationModelOptionsV2Model `json:"v2Model,omitempty"` // ForceSendFields is a list of field names (e.g. "V1Model") to // unconditionally include in API requests. By default, fields with @@ -710,6 +767,48 @@ func (s *ClassificationModelOptions) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ClassificationModelOptionsV1Model: Options for the V1 model. +type ClassificationModelOptionsV1Model struct { +} + +// ClassificationModelOptionsV2Model: Options for the V2 model. +type ClassificationModelOptionsV2Model struct { + // ContentCategoriesVersion: The content categories used for + // classification. + // + // Possible values: + // "CONTENT_CATEGORIES_VERSION_UNSPECIFIED" - If + // `ContentCategoriesVersion` is not specified, this option will default + // to `V1`. + // "V1" - Legacy content categories of our initial launch in 2017. + // "V2" - Updated content categories in 2022. + ContentCategoriesVersion string `json:"contentCategoriesVersion,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ContentCategoriesVersion") 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. "ContentCategoriesVersion") + // 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 *ClassificationModelOptionsV2Model) MarshalJSON() ([]byte, error) { + type NoMethod ClassificationModelOptionsV2Model + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ClassifyTextRequest: The document classification request message. type ClassifyTextRequest struct { // ClassificationModelOptions: Optional. Model options to use for @@ -776,6 +875,347 @@ func (s *ClassifyTextResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Color: Represents a color in the RGBA color space. This +// representation is designed for simplicity of conversion to and from +// color representations in various languages over compactness. For +// example, the fields of this representation can be trivially provided +// to the constructor of `java.awt.Color` in Java; it can also be +// trivially provided to UIColor's `+colorWithRed:green:blue:alpha` +// method in iOS; and, with just a little work, it can be easily +// formatted into a CSS `rgba()` string in JavaScript. This reference +// page doesn't have information about the absolute color space that +// should be used to interpret the RGB value—for example, sRGB, Adobe +// RGB, DCI-P3, and BT.2020. By default, applications should assume the +// sRGB color space. When color equality needs to be decided, +// implementations, unless documented otherwise, treat two colors as +// equal if all their red, green, blue, and alpha values each differ by +// at most `1e-5`. Example (Java): import com.google.type.Color; // ... +// public static java.awt.Color fromProto(Color protocolor) { float +// alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : +// 1.0; return new java.awt.Color( protocolor.getRed(), +// protocolor.getGreen(), protocolor.getBlue(), alpha); } public static +// Color toProto(java.awt.Color color) { float red = (float) +// color.getRed(); float green = (float) color.getGreen(); float blue = +// (float) color.getBlue(); float denominator = 255.0; Color.Builder +// resultBuilder = Color .newBuilder() .setRed(red / denominator) +// .setGreen(green / denominator) .setBlue(blue / denominator); int +// alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( +// FloatValue .newBuilder() .setValue(((float) alpha) / denominator) +// .build()); } return resultBuilder.build(); } // ... Example (iOS / +// Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float +// red = [protocolor red]; float green = [protocolor green]; float blue +// = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; +// float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper +// value]; } return [UIColor colorWithRed:red green:green blue:blue +// alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, +// green, blue, alpha; if (![color getRed:&red green:&green blue:&blue +// alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; +// [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; +// if (alpha <= 0.9999) { [result +// setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; +// return result; } // ... Example (JavaScript): // ... var +// protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red +// || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = +// rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green +// = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); +// if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, +// blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams +// = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', +// alphaFrac, ')'].join(”); }; var rgbToCssColor = function(red, green, +// blue) { var rgbNumber = new Number((red << 16) | (green << 8) | +// blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - +// hexString.length; var resultBuilder = ['#']; for (var i = 0; i < +// missingZeros; i++) { resultBuilder.push('0'); } +// resultBuilder.push(hexString); return resultBuilder.join(”); }; // +// ... +type Color struct { + // Alpha: The fraction of this color that should be applied to the + // pixel. That is, the final pixel color is defined by the equation: + // `pixel color = alpha * (this color) + (1.0 - alpha) * (background + // color)` This means that a value of 1.0 corresponds to a solid color, + // whereas a value of 0.0 corresponds to a completely transparent color. + // This uses a wrapper message rather than a simple float scalar so that + // it is possible to distinguish between a default value and the value + // being unset. If omitted, this color object is rendered as a solid + // color (as if the alpha value had been explicitly given a value of + // 1.0). + Alpha float64 `json:"alpha,omitempty"` + + // Blue: The amount of blue in the color as a value in the interval [0, + // 1]. + Blue float64 `json:"blue,omitempty"` + + // Green: The amount of green in the color as a value in the interval + // [0, 1]. + Green float64 `json:"green,omitempty"` + + // Red: The amount of red in the color as a value in the interval [0, + // 1]. + Red float64 `json:"red,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Alpha") 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. "Alpha") 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 *Color) MarshalJSON() ([]byte, error) { + type NoMethod Color + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *Color) UnmarshalJSON(data []byte) error { + type NoMethod Color + var s1 struct { + Alpha gensupport.JSONFloat64 `json:"alpha"` + Blue gensupport.JSONFloat64 `json:"blue"` + Green gensupport.JSONFloat64 `json:"green"` + Red gensupport.JSONFloat64 `json:"red"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Alpha = float64(s1.Alpha) + s.Blue = float64(s1.Blue) + s.Green = float64(s1.Green) + s.Red = float64(s1.Red) + return nil +} + +// CpuMetric: Metric for billing reports. +type CpuMetric struct { + // CoreNumber: Required. Number of CPU cores. + CoreNumber int64 `json:"coreNumber,omitempty,string"` + + // CoreSec: Required. Total seconds of core usage, e.g. 4. + CoreSec int64 `json:"coreSec,omitempty,string"` + + // CpuType: Required. Type of cpu, e.g. N2. + // + // Possible values: + // "UNKNOWN_CPU_TYPE" + // "A2" - GPU-based machine, skip quota reporting. + // "A3" - GPU-based machine, skip quota reporting. + // "C2" - COMPUTE_OPTIMIZED + // "C2D" + // "CUSTOM" + // "E2" + // "G2" - GPU-based machine, skip quota reporting. + // "C3" + // "M2" - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + // "M1" - MEMORY_OPTIMIZED + // "N1" + // "N2_CUSTOM" + // "N2" + // "N2D" + CpuType string `json:"cpuType,omitempty"` + + // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. + // + // Possible values: + // "UNKNOWN_MACHINE_SPEC" + // "N1_STANDARD_2" + // "N1_STANDARD_4" + // "N1_STANDARD_8" + // "N1_STANDARD_16" + // "N1_STANDARD_32" + // "N1_STANDARD_64" + // "N1_STANDARD_96" + // "N1_HIGHMEM_2" + // "N1_HIGHMEM_4" + // "N1_HIGHMEM_8" + // "N1_HIGHMEM_16" + // "N1_HIGHMEM_32" + // "N1_HIGHMEM_64" + // "N1_HIGHMEM_96" + // "N1_HIGHCPU_2" + // "N1_HIGHCPU_4" + // "N1_HIGHCPU_8" + // "N1_HIGHCPU_16" + // "N1_HIGHCPU_32" + // "N1_HIGHCPU_64" + // "N1_HIGHCPU_96" + // "A2_HIGHGPU_1G" + // "A2_HIGHGPU_2G" + // "A2_HIGHGPU_4G" + // "A2_HIGHGPU_8G" + // "A2_MEGAGPU_16G" + // "A2_ULTRAGPU_1G" + // "A2_ULTRAGPU_2G" + // "A2_ULTRAGPU_4G" + // "A2_ULTRAGPU_8G" + // "A3_HIGHGPU_8G" + // "E2_STANDARD_2" + // "E2_STANDARD_4" + // "E2_STANDARD_8" + // "E2_STANDARD_16" + // "E2_STANDARD_32" + // "E2_HIGHMEM_2" + // "E2_HIGHMEM_4" + // "E2_HIGHMEM_8" + // "E2_HIGHMEM_16" + // "E2_HIGHCPU_2" + // "E2_HIGHCPU_4" + // "E2_HIGHCPU_8" + // "E2_HIGHCPU_16" + // "E2_HIGHCPU_32" + // "N2_STANDARD_2" + // "N2_STANDARD_4" + // "N2_STANDARD_8" + // "N2_STANDARD_16" + // "N2_STANDARD_32" + // "N2_STANDARD_48" + // "N2_STANDARD_64" + // "N2_STANDARD_80" + // "N2_STANDARD_96" + // "N2_STANDARD_128" + // "N2_HIGHMEM_2" + // "N2_HIGHMEM_4" + // "N2_HIGHMEM_8" + // "N2_HIGHMEM_16" + // "N2_HIGHMEM_32" + // "N2_HIGHMEM_48" + // "N2_HIGHMEM_64" + // "N2_HIGHMEM_80" + // "N2_HIGHMEM_96" + // "N2_HIGHMEM_128" + // "N2_HIGHCPU_2" + // "N2_HIGHCPU_4" + // "N2_HIGHCPU_8" + // "N2_HIGHCPU_16" + // "N2_HIGHCPU_32" + // "N2_HIGHCPU_48" + // "N2_HIGHCPU_64" + // "N2_HIGHCPU_80" + // "N2_HIGHCPU_96" + // "N2D_STANDARD_2" + // "N2D_STANDARD_4" + // "N2D_STANDARD_8" + // "N2D_STANDARD_16" + // "N2D_STANDARD_32" + // "N2D_STANDARD_48" + // "N2D_STANDARD_64" + // "N2D_STANDARD_80" + // "N2D_STANDARD_96" + // "N2D_STANDARD_128" + // "N2D_STANDARD_224" + // "N2D_HIGHMEM_2" + // "N2D_HIGHMEM_4" + // "N2D_HIGHMEM_8" + // "N2D_HIGHMEM_16" + // "N2D_HIGHMEM_32" + // "N2D_HIGHMEM_48" + // "N2D_HIGHMEM_64" + // "N2D_HIGHMEM_80" + // "N2D_HIGHMEM_96" + // "N2D_HIGHCPU_2" + // "N2D_HIGHCPU_4" + // "N2D_HIGHCPU_8" + // "N2D_HIGHCPU_16" + // "N2D_HIGHCPU_32" + // "N2D_HIGHCPU_48" + // "N2D_HIGHCPU_64" + // "N2D_HIGHCPU_80" + // "N2D_HIGHCPU_96" + // "N2D_HIGHCPU_128" + // "N2D_HIGHCPU_224" + // "C2_STANDARD_4" + // "C2_STANDARD_8" + // "C2_STANDARD_16" + // "C2_STANDARD_30" + // "C2_STANDARD_60" + // "C2D_STANDARD_2" + // "C2D_STANDARD_4" + // "C2D_STANDARD_8" + // "C2D_STANDARD_16" + // "C2D_STANDARD_32" + // "C2D_STANDARD_56" + // "C2D_STANDARD_112" + // "C2D_HIGHCPU_2" + // "C2D_HIGHCPU_4" + // "C2D_HIGHCPU_8" + // "C2D_HIGHCPU_16" + // "C2D_HIGHCPU_32" + // "C2D_HIGHCPU_56" + // "C2D_HIGHCPU_112" + // "C2D_HIGHMEM_2" + // "C2D_HIGHMEM_4" + // "C2D_HIGHMEM_8" + // "C2D_HIGHMEM_16" + // "C2D_HIGHMEM_32" + // "C2D_HIGHMEM_56" + // "C2D_HIGHMEM_112" + // "G2_STANDARD_4" + // "G2_STANDARD_8" + // "G2_STANDARD_12" + // "G2_STANDARD_16" + // "G2_STANDARD_24" + // "G2_STANDARD_32" + // "G2_STANDARD_48" + // "G2_STANDARD_96" + // "C3_STANDARD_4" + // "C3_STANDARD_8" + // "C3_STANDARD_22" + // "C3_STANDARD_44" + // "C3_STANDARD_88" + // "C3_STANDARD_176" + // "C3_HIGHCPU_4" + // "C3_HIGHCPU_8" + // "C3_HIGHCPU_22" + // "C3_HIGHCPU_44" + // "C3_HIGHCPU_88" + // "C3_HIGHCPU_176" + // "C3_HIGHMEM_4" + // "C3_HIGHMEM_8" + // "C3_HIGHMEM_22" + // "C3_HIGHMEM_44" + // "C3_HIGHMEM_88" + // "C3_HIGHMEM_176" + MachineSpec string `json:"machineSpec,omitempty"` + + // TrackingLabels: Billing tracking labels. They do not contain any user + // data but only the labels set by Vertex Core Infra itself. Tracking + // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ + // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + TrackingLabels map[string]string `json:"trackingLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CoreNumber") 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. "CoreNumber") 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 *CpuMetric) MarshalJSON() ([]byte, error) { + type NoMethod CpuMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // DependencyEdge: Represents dependency parse tree information for a // token. type DependencyEdge struct { @@ -900,6 +1340,44 @@ func (s *DependencyEdge) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type DiskMetric struct { + // DiskType: Required. Type of Disk, e.g. REGIONAL_SSD. + // + // Possible values: + // "UNKNOWN_DISK_TYPE" + // "REGIONAL_SSD" + // "REGIONAL_STORAGE" + // "PD_SSD" + // "PD_STANDARD" + // "STORAGE_SNAPSHOT" + DiskType string `json:"diskType,omitempty"` + + // GibSec: Required. Seconds of physical disk usage, e.g. 3600. + GibSec int64 `json:"gibSec,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DiskType") 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. "DiskType") 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 *DiskMetric) MarshalJSON() ([]byte, error) { + type NoMethod DiskMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Document: Represents the input to API methods. type Document struct { // BoilerplateHandling: Indicates how detected boilerplate(e.g. @@ -1118,59 +1596,254 @@ func (s *EntityMention) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Features: All available features for sentiment, syntax, and semantic -// analysis. Setting each one to true will enable that specific analysis -// for the input. Next ID: 12 -type Features struct { - // ClassificationModelOptions: Optional. The model options to use for - // classification. Defaults to v1 options if not specified. Only used if - // `classify_text` is set to true. - ClassificationModelOptions *ClassificationModelOptions `json:"classificationModelOptions,omitempty"` +type GpuMetric struct { + // GpuSec: Required. Seconds of GPU usage, e.g. 3600. + GpuSec int64 `json:"gpuSec,omitempty,string"` - // ClassifyText: Classify the full document into categories. If this is - // true, the API will use the default model which classifies into a - // predefined taxonomy - // (https://cloud.google.com/natural-language/docs/categories). - ClassifyText bool `json:"classifyText,omitempty"` + // GpuType: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + // + // Possible values: + // "UNKNOWN_GPU_TYPE" + // "NVIDIA_TESLA_A100" + // "NVIDIA_A100_80GB" + // "NVIDIA_TESLA_K80" + // "NVIDIA_L4" + // "NVIDIA_TESLA_P100" + // "NVIDIA_TESLA_P4" + // "NVIDIA_TESLA_T4" + // "NVIDIA_TESLA_V100" + // "NVIDIA_H100_80GB" + GpuType string `json:"gpuType,omitempty"` + + // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. + // + // Possible values: + // "UNKNOWN_MACHINE_SPEC" + // "N1_STANDARD_2" + // "N1_STANDARD_4" + // "N1_STANDARD_8" + // "N1_STANDARD_16" + // "N1_STANDARD_32" + // "N1_STANDARD_64" + // "N1_STANDARD_96" + // "N1_HIGHMEM_2" + // "N1_HIGHMEM_4" + // "N1_HIGHMEM_8" + // "N1_HIGHMEM_16" + // "N1_HIGHMEM_32" + // "N1_HIGHMEM_64" + // "N1_HIGHMEM_96" + // "N1_HIGHCPU_2" + // "N1_HIGHCPU_4" + // "N1_HIGHCPU_8" + // "N1_HIGHCPU_16" + // "N1_HIGHCPU_32" + // "N1_HIGHCPU_64" + // "N1_HIGHCPU_96" + // "A2_HIGHGPU_1G" + // "A2_HIGHGPU_2G" + // "A2_HIGHGPU_4G" + // "A2_HIGHGPU_8G" + // "A2_MEGAGPU_16G" + // "A2_ULTRAGPU_1G" + // "A2_ULTRAGPU_2G" + // "A2_ULTRAGPU_4G" + // "A2_ULTRAGPU_8G" + // "A3_HIGHGPU_8G" + // "E2_STANDARD_2" + // "E2_STANDARD_4" + // "E2_STANDARD_8" + // "E2_STANDARD_16" + // "E2_STANDARD_32" + // "E2_HIGHMEM_2" + // "E2_HIGHMEM_4" + // "E2_HIGHMEM_8" + // "E2_HIGHMEM_16" + // "E2_HIGHCPU_2" + // "E2_HIGHCPU_4" + // "E2_HIGHCPU_8" + // "E2_HIGHCPU_16" + // "E2_HIGHCPU_32" + // "N2_STANDARD_2" + // "N2_STANDARD_4" + // "N2_STANDARD_8" + // "N2_STANDARD_16" + // "N2_STANDARD_32" + // "N2_STANDARD_48" + // "N2_STANDARD_64" + // "N2_STANDARD_80" + // "N2_STANDARD_96" + // "N2_STANDARD_128" + // "N2_HIGHMEM_2" + // "N2_HIGHMEM_4" + // "N2_HIGHMEM_8" + // "N2_HIGHMEM_16" + // "N2_HIGHMEM_32" + // "N2_HIGHMEM_48" + // "N2_HIGHMEM_64" + // "N2_HIGHMEM_80" + // "N2_HIGHMEM_96" + // "N2_HIGHMEM_128" + // "N2_HIGHCPU_2" + // "N2_HIGHCPU_4" + // "N2_HIGHCPU_8" + // "N2_HIGHCPU_16" + // "N2_HIGHCPU_32" + // "N2_HIGHCPU_48" + // "N2_HIGHCPU_64" + // "N2_HIGHCPU_80" + // "N2_HIGHCPU_96" + // "N2D_STANDARD_2" + // "N2D_STANDARD_4" + // "N2D_STANDARD_8" + // "N2D_STANDARD_16" + // "N2D_STANDARD_32" + // "N2D_STANDARD_48" + // "N2D_STANDARD_64" + // "N2D_STANDARD_80" + // "N2D_STANDARD_96" + // "N2D_STANDARD_128" + // "N2D_STANDARD_224" + // "N2D_HIGHMEM_2" + // "N2D_HIGHMEM_4" + // "N2D_HIGHMEM_8" + // "N2D_HIGHMEM_16" + // "N2D_HIGHMEM_32" + // "N2D_HIGHMEM_48" + // "N2D_HIGHMEM_64" + // "N2D_HIGHMEM_80" + // "N2D_HIGHMEM_96" + // "N2D_HIGHCPU_2" + // "N2D_HIGHCPU_4" + // "N2D_HIGHCPU_8" + // "N2D_HIGHCPU_16" + // "N2D_HIGHCPU_32" + // "N2D_HIGHCPU_48" + // "N2D_HIGHCPU_64" + // "N2D_HIGHCPU_80" + // "N2D_HIGHCPU_96" + // "N2D_HIGHCPU_128" + // "N2D_HIGHCPU_224" + // "C2_STANDARD_4" + // "C2_STANDARD_8" + // "C2_STANDARD_16" + // "C2_STANDARD_30" + // "C2_STANDARD_60" + // "C2D_STANDARD_2" + // "C2D_STANDARD_4" + // "C2D_STANDARD_8" + // "C2D_STANDARD_16" + // "C2D_STANDARD_32" + // "C2D_STANDARD_56" + // "C2D_STANDARD_112" + // "C2D_HIGHCPU_2" + // "C2D_HIGHCPU_4" + // "C2D_HIGHCPU_8" + // "C2D_HIGHCPU_16" + // "C2D_HIGHCPU_32" + // "C2D_HIGHCPU_56" + // "C2D_HIGHCPU_112" + // "C2D_HIGHMEM_2" + // "C2D_HIGHMEM_4" + // "C2D_HIGHMEM_8" + // "C2D_HIGHMEM_16" + // "C2D_HIGHMEM_32" + // "C2D_HIGHMEM_56" + // "C2D_HIGHMEM_112" + // "G2_STANDARD_4" + // "G2_STANDARD_8" + // "G2_STANDARD_12" + // "G2_STANDARD_16" + // "G2_STANDARD_24" + // "G2_STANDARD_32" + // "G2_STANDARD_48" + // "G2_STANDARD_96" + // "C3_STANDARD_4" + // "C3_STANDARD_8" + // "C3_STANDARD_22" + // "C3_STANDARD_44" + // "C3_STANDARD_88" + // "C3_STANDARD_176" + // "C3_HIGHCPU_4" + // "C3_HIGHCPU_8" + // "C3_HIGHCPU_22" + // "C3_HIGHCPU_44" + // "C3_HIGHCPU_88" + // "C3_HIGHCPU_176" + // "C3_HIGHMEM_4" + // "C3_HIGHMEM_8" + // "C3_HIGHMEM_22" + // "C3_HIGHMEM_44" + // "C3_HIGHMEM_88" + // "C3_HIGHMEM_176" + MachineSpec string `json:"machineSpec,omitempty"` + + // TrackingLabels: Billing tracking labels. They do not contain any user + // data but only the labels set by Vertex Core Infra itself. Tracking + // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ + // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + TrackingLabels map[string]string `json:"trackingLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GpuSec") 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:"-"` - // ExtractDocumentSentiment: Extract document-level sentiment. - ExtractDocumentSentiment bool `json:"extractDocumentSentiment,omitempty"` + // NullFields is a list of field names (e.g. "GpuSec") 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:"-"` +} - // ExtractEntities: Extract entities. - ExtractEntities bool `json:"extractEntities,omitempty"` +func (s *GpuMetric) MarshalJSON() ([]byte, error) { + type NoMethod GpuMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} - // ExtractEntitySentiment: Extract entities and their associated - // sentiment. - ExtractEntitySentiment bool `json:"extractEntitySentiment,omitempty"` +// InfraUsage: Infra Usage of billing metrics. Next ID: 6 +type InfraUsage struct { + // CpuMetrics: Aggregated core metrics since requested start_time. + CpuMetrics []*CpuMetric `json:"cpuMetrics,omitempty"` - // ExtractSyntax: Extract syntax information. - ExtractSyntax bool `json:"extractSyntax,omitempty"` + // DiskMetrics: Aggregated persistent disk metrics since requested + // start_time. + DiskMetrics []*DiskMetric `json:"diskMetrics,omitempty"` - // ModerateText: Moderate the document for harmful and sensitive - // categories. - ModerateText bool `json:"moderateText,omitempty"` + // GpuMetrics: Aggregated gpu metrics since requested start_time. + GpuMetrics []*GpuMetric `json:"gpuMetrics,omitempty"` - // ForceSendFields is a list of field names (e.g. - // "ClassificationModelOptions") 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. + // RamMetrics: Aggregated ram metrics since requested start_time. + RamMetrics []*RamMetric `json:"ramMetrics,omitempty"` + + // TpuMetrics: Aggregated tpu metrics since requested start_time. + TpuMetrics []*TpuMetric `json:"tpuMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CpuMetrics") 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. - // "ClassificationModelOptions") 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. "CpuMetrics") 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 *Features) MarshalJSON() ([]byte, error) { - type NoMethod Features +func (s *InfraUsage) MarshalJSON() ([]byte, error) { + type NoMethod InfraUsage raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } @@ -1416,17 +2089,204 @@ func (s *PartOfSpeech) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Sentence: Represents a sentence in the input document. -type Sentence struct { - // Sentiment: For calls to AnalyzeSentiment or if - // AnnotateTextRequest.Features.extract_document_sentiment is set to - // true, this field will contain the sentiment for the sentence. - Sentiment *Sentiment `json:"sentiment,omitempty"` - - // Text: The sentence text. - Text *TextSpan `json:"text,omitempty"` +type RamMetric struct { + // GibSec: Required. VM memory in Gigabyte second, e.g. 3600. Using + // int64 type to match billing metrics definition. + GibSec int64 `json:"gibSec,omitempty,string"` - // ForceSendFields is a list of field names (e.g. "Sentiment") to + // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. + // + // Possible values: + // "UNKNOWN_MACHINE_SPEC" + // "N1_STANDARD_2" + // "N1_STANDARD_4" + // "N1_STANDARD_8" + // "N1_STANDARD_16" + // "N1_STANDARD_32" + // "N1_STANDARD_64" + // "N1_STANDARD_96" + // "N1_HIGHMEM_2" + // "N1_HIGHMEM_4" + // "N1_HIGHMEM_8" + // "N1_HIGHMEM_16" + // "N1_HIGHMEM_32" + // "N1_HIGHMEM_64" + // "N1_HIGHMEM_96" + // "N1_HIGHCPU_2" + // "N1_HIGHCPU_4" + // "N1_HIGHCPU_8" + // "N1_HIGHCPU_16" + // "N1_HIGHCPU_32" + // "N1_HIGHCPU_64" + // "N1_HIGHCPU_96" + // "A2_HIGHGPU_1G" + // "A2_HIGHGPU_2G" + // "A2_HIGHGPU_4G" + // "A2_HIGHGPU_8G" + // "A2_MEGAGPU_16G" + // "A2_ULTRAGPU_1G" + // "A2_ULTRAGPU_2G" + // "A2_ULTRAGPU_4G" + // "A2_ULTRAGPU_8G" + // "A3_HIGHGPU_8G" + // "E2_STANDARD_2" + // "E2_STANDARD_4" + // "E2_STANDARD_8" + // "E2_STANDARD_16" + // "E2_STANDARD_32" + // "E2_HIGHMEM_2" + // "E2_HIGHMEM_4" + // "E2_HIGHMEM_8" + // "E2_HIGHMEM_16" + // "E2_HIGHCPU_2" + // "E2_HIGHCPU_4" + // "E2_HIGHCPU_8" + // "E2_HIGHCPU_16" + // "E2_HIGHCPU_32" + // "N2_STANDARD_2" + // "N2_STANDARD_4" + // "N2_STANDARD_8" + // "N2_STANDARD_16" + // "N2_STANDARD_32" + // "N2_STANDARD_48" + // "N2_STANDARD_64" + // "N2_STANDARD_80" + // "N2_STANDARD_96" + // "N2_STANDARD_128" + // "N2_HIGHMEM_2" + // "N2_HIGHMEM_4" + // "N2_HIGHMEM_8" + // "N2_HIGHMEM_16" + // "N2_HIGHMEM_32" + // "N2_HIGHMEM_48" + // "N2_HIGHMEM_64" + // "N2_HIGHMEM_80" + // "N2_HIGHMEM_96" + // "N2_HIGHMEM_128" + // "N2_HIGHCPU_2" + // "N2_HIGHCPU_4" + // "N2_HIGHCPU_8" + // "N2_HIGHCPU_16" + // "N2_HIGHCPU_32" + // "N2_HIGHCPU_48" + // "N2_HIGHCPU_64" + // "N2_HIGHCPU_80" + // "N2_HIGHCPU_96" + // "N2D_STANDARD_2" + // "N2D_STANDARD_4" + // "N2D_STANDARD_8" + // "N2D_STANDARD_16" + // "N2D_STANDARD_32" + // "N2D_STANDARD_48" + // "N2D_STANDARD_64" + // "N2D_STANDARD_80" + // "N2D_STANDARD_96" + // "N2D_STANDARD_128" + // "N2D_STANDARD_224" + // "N2D_HIGHMEM_2" + // "N2D_HIGHMEM_4" + // "N2D_HIGHMEM_8" + // "N2D_HIGHMEM_16" + // "N2D_HIGHMEM_32" + // "N2D_HIGHMEM_48" + // "N2D_HIGHMEM_64" + // "N2D_HIGHMEM_80" + // "N2D_HIGHMEM_96" + // "N2D_HIGHCPU_2" + // "N2D_HIGHCPU_4" + // "N2D_HIGHCPU_8" + // "N2D_HIGHCPU_16" + // "N2D_HIGHCPU_32" + // "N2D_HIGHCPU_48" + // "N2D_HIGHCPU_64" + // "N2D_HIGHCPU_80" + // "N2D_HIGHCPU_96" + // "N2D_HIGHCPU_128" + // "N2D_HIGHCPU_224" + // "C2_STANDARD_4" + // "C2_STANDARD_8" + // "C2_STANDARD_16" + // "C2_STANDARD_30" + // "C2_STANDARD_60" + // "C2D_STANDARD_2" + // "C2D_STANDARD_4" + // "C2D_STANDARD_8" + // "C2D_STANDARD_16" + // "C2D_STANDARD_32" + // "C2D_STANDARD_56" + // "C2D_STANDARD_112" + // "C2D_HIGHCPU_2" + // "C2D_HIGHCPU_4" + // "C2D_HIGHCPU_8" + // "C2D_HIGHCPU_16" + // "C2D_HIGHCPU_32" + // "C2D_HIGHCPU_56" + // "C2D_HIGHCPU_112" + // "C2D_HIGHMEM_2" + // "C2D_HIGHMEM_4" + // "C2D_HIGHMEM_8" + // "C2D_HIGHMEM_16" + // "C2D_HIGHMEM_32" + // "C2D_HIGHMEM_56" + // "C2D_HIGHMEM_112" + // "G2_STANDARD_4" + // "G2_STANDARD_8" + // "G2_STANDARD_12" + // "G2_STANDARD_16" + // "G2_STANDARD_24" + // "G2_STANDARD_32" + // "G2_STANDARD_48" + // "G2_STANDARD_96" + // "C3_STANDARD_4" + // "C3_STANDARD_8" + // "C3_STANDARD_22" + // "C3_STANDARD_44" + // "C3_STANDARD_88" + // "C3_STANDARD_176" + // "C3_HIGHCPU_4" + // "C3_HIGHCPU_8" + // "C3_HIGHCPU_22" + // "C3_HIGHCPU_44" + // "C3_HIGHCPU_88" + // "C3_HIGHCPU_176" + // "C3_HIGHMEM_4" + // "C3_HIGHMEM_8" + // "C3_HIGHMEM_22" + // "C3_HIGHMEM_44" + // "C3_HIGHMEM_88" + // "C3_HIGHMEM_176" + MachineSpec string `json:"machineSpec,omitempty"` + + // Memories: Required. VM memory in gb. + Memories float64 `json:"memories,omitempty"` + + // RamType: Required. Type of ram. + // + // Possible values: + // "UNKNOWN_RAM_TYPE" + // "A2" + // "A3" + // "C2" - COMPUTE_OPTIMIZED + // "C2D" + // "CUSTOM" + // "E2" + // "G2" + // "C3" + // "M2" - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + // "M1" - MEMORY_OPTIMIZED + // "N1" + // "N2_CUSTOM" + // "N2" + // "N2D" + RamType string `json:"ramType,omitempty"` + + // TrackingLabels: Billing tracking labels. They do not contain any user + // data but only the labels set by Vertex Core Infra itself. Tracking + // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ + // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + TrackingLabels map[string]string `json:"trackingLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GibSec") 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 @@ -1434,8 +2294,8 @@ type Sentence struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Sentiment") to include in - // API requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "GibSec") 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. @@ -1443,20 +2303,67 @@ type Sentence struct { NullFields []string `json:"-"` } -func (s *Sentence) MarshalJSON() ([]byte, error) { - type NoMethod Sentence +func (s *RamMetric) MarshalJSON() ([]byte, error) { + type NoMethod RamMetric raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Sentiment: Represents the feeling associated with the entire text or -// entities in the text. Next ID: 6 -type Sentiment struct { - // Magnitude: A non-negative number in the [0, +inf) range, which - // represents the absolute magnitude of sentiment regardless of score - // (positive or negative). - Magnitude float64 `json:"magnitude,omitempty"` - +func (s *RamMetric) UnmarshalJSON(data []byte) error { + type NoMethod RamMetric + var s1 struct { + Memories gensupport.JSONFloat64 `json:"memories"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Memories = float64(s1.Memories) + return nil +} + +// Sentence: Represents a sentence in the input document. +type Sentence struct { + // Sentiment: For calls to AnalyzeSentiment or if + // AnnotateTextRequest.Features.extract_document_sentiment is set to + // true, this field will contain the sentiment for the sentence. + Sentiment *Sentiment `json:"sentiment,omitempty"` + + // Text: The sentence text. + Text *TextSpan `json:"text,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Sentiment") 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. "Sentiment") 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 *Sentence) MarshalJSON() ([]byte, error) { + type NoMethod Sentence + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Sentiment: Represents the feeling associated with the entire text or +// entities in the text. Next ID: 6 +type Sentiment struct { + // Magnitude: A non-negative number in the [0, +inf) range, which + // represents the absolute magnitude of sentiment regardless of score + // (positive or negative). + Magnitude float64 `json:"magnitude,omitempty"` + // Score: Sentiment score between -1.0 (negative sentiment) and 1.0 // (positive sentiment). Score float64 `json:"score,omitempty"` @@ -1617,25 +2524,123 @@ func (s *Token) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// V1Model: Options for the V1 model. -type V1Model struct { -} +type TpuMetric struct { + // TpuSec: Required. Seconds of TPU usage, e.g. 3600. + TpuSec int64 `json:"tpuSec,omitempty,string"` -// V2Model: Options for the V2 model. -type V2Model struct { - // ContentCategoriesVersion: The content categories used for - // classification. + // TpuType: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. // // Possible values: - // "CONTENT_CATEGORIES_VERSION_UNSPECIFIED" - If - // `ContentCategoriesVersion` is not specified, this option will default - // to `V1`. - // "V1" - Legacy content categories of our initial launch in 2017. - // "V2" - Updated content categories in 2022. - ContentCategoriesVersion string `json:"contentCategoriesVersion,omitempty"` + // "UNKNOWN_TPU_TYPE" + // "TPU_V2_POD" + // "TPU_V2" + // "TPU_V3_POD" + // "TPU_V3" + // "TPU_V5_LITEPOD" + TpuType string `json:"tpuType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "TpuSec") 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. "TpuSec") 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 *TpuMetric) MarshalJSON() ([]byte, error) { + type NoMethod TpuMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSArrayStats: The data statistics of a series of ARRAY values. +type XPSArrayStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // MemberStats: Stats of all the values of all arrays, as if they were a + // single long series of data. The type depends on the element type of + // the array. + MemberStats *XPSDataStats `json:"memberStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSArrayStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSArrayStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSBatchPredictResponse struct { + // ExampleSet: Examples for batch prediction result. Under full API + // implementation, results are stored in shared RecordIO of + // AnnotatedExample protobufs, the annotations field of which is + // populated by XPS backend. + ExampleSet *XPSExampleSet `json:"exampleSet,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExampleSet") 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. "ExampleSet") 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 *XPSBatchPredictResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSBatchPredictResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSBoundingBoxMetricsEntry: Bounding box matching model metrics for a +// single intersection-over-union threshold and multiple label match +// confidence thresholds. +type XPSBoundingBoxMetricsEntry struct { + // ConfidenceMetricsEntries: Metrics for each label-match + // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + ConfidenceMetricsEntries []*XPSBoundingBoxMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // IouThreshold: The intersection-over-union threshold value used to + // compute this metrics entry. + IouThreshold float64 `json:"iouThreshold,omitempty"` + + // MeanAveragePrecision: The mean average precision. + MeanAveragePrecision float64 `json:"meanAveragePrecision,omitempty"` // ForceSendFields is a list of field names (e.g. - // "ContentCategoriesVersion") to unconditionally include in API + // "ConfidenceMetricsEntries") 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 @@ -1643,7 +2648,7 @@ type V2Model struct { // fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ContentCategoriesVersion") + // NullFields is a list of field names (e.g. "ConfidenceMetricsEntries") // 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 @@ -1653,8 +2658,5017 @@ type V2Model struct { NullFields []string `json:"-"` } -func (s *V2Model) MarshalJSON() ([]byte, error) { - type NoMethod V2Model +func (s *XPSBoundingBoxMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSBoundingBoxMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSBoundingBoxMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSBoundingBoxMetricsEntry + var s1 struct { + IouThreshold gensupport.JSONFloat64 `json:"iouThreshold"` + MeanAveragePrecision gensupport.JSONFloat64 `json:"meanAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.IouThreshold = float64(s1.IouThreshold) + s.MeanAveragePrecision = float64(s1.MeanAveragePrecision) + return nil +} + +// XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: Metrics for a +// single confidence threshold. +type XPSBoundingBoxMetricsEntryConfidenceMetricsEntry struct { + // ConfidenceThreshold: The confidence threshold value used to compute + // the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // Precision: Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // Recall: Recall for the given confidence threshold. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + return nil +} + +// XPSCategoryStats: The data statistics of a series of CATEGORY values. +type XPSCategoryStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // TopCategoryStats: The statistics of the top 20 CATEGORY values, + // ordered by CategoryStats.SingleCategoryStats.count. + TopCategoryStats []*XPSCategoryStatsSingleCategoryStats `json:"topCategoryStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSCategoryStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCategoryStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSCategoryStatsSingleCategoryStats: The statistics of a single +// CATEGORY value. +type XPSCategoryStatsSingleCategoryStats struct { + // Count: The number of occurrences of this value in the series. + Count int64 `json:"count,omitempty,string"` + + // Value: The CATEGORY value. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSCategoryStatsSingleCategoryStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCategoryStatsSingleCategoryStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSClassificationEvaluationMetrics: Model evaluation metrics for +// classification problems. It can be used for image and video +// classification. Next tag: 9. +type XPSClassificationEvaluationMetrics struct { + // AuPrc: The Area under precision recall curve metric. + AuPrc float64 `json:"auPrc,omitempty"` + + // AuRoc: The Area Under Receiver Operating Characteristic curve metric. + // Micro-averaged for the overall evaluation. + AuRoc float64 `json:"auRoc,omitempty"` + + // BaseAuPrc: The Area under precision recall curve metric based on + // priors. + BaseAuPrc float64 `json:"baseAuPrc,omitempty"` + + // ConfidenceMetricsEntries: Metrics that have confidence thresholds. + // Precision-recall curve can be derived from it. + ConfidenceMetricsEntries []*XPSConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // ConfusionMatrix: Confusion matrix of the evaluation. Only set for + // MULTICLASS classification problems where number of annotation specs + // is no more than 10. Only set for model level evaluation, not for + // evaluation per label. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // EvaluatedExamplesCount: The number of examples used for model + // evaluation. + EvaluatedExamplesCount int64 `json:"evaluatedExamplesCount,omitempty"` + + // LogLoss: The Log Loss metric. + LogLoss float64 `json:"logLoss,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AuPrc") 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. "AuPrc") 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 *XPSClassificationEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSClassificationEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSClassificationEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSClassificationEvaluationMetrics + var s1 struct { + AuPrc gensupport.JSONFloat64 `json:"auPrc"` + AuRoc gensupport.JSONFloat64 `json:"auRoc"` + BaseAuPrc gensupport.JSONFloat64 `json:"baseAuPrc"` + LogLoss gensupport.JSONFloat64 `json:"logLoss"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.AuPrc = float64(s1.AuPrc) + s.AuRoc = float64(s1.AuRoc) + s.BaseAuPrc = float64(s1.BaseAuPrc) + s.LogLoss = float64(s1.LogLoss) + return nil +} + +// XPSColorMap: Map from color to display name. Will only be used by +// Image Segmentation for uCAIP. +type XPSColorMap struct { + // AnnotationSpecIdToken: Should be used during training. + AnnotationSpecIdToken string `json:"annotationSpecIdToken,omitempty"` + + // Color: This type is deprecated in favor of the IntColor below. This + // is because google.type.Color represent color has a float which + // semantically does not reflect discrete classes/categories concept. + // Moreover, to handle it well we need to have some tolerance when + // converting to a discretized color. As such, the recommendation is to + // have API surface still use google.type.Color while internally + // IntColor is used. + Color *Color `json:"color,omitempty"` + + // DisplayName: Should be used during preprocessing. + DisplayName string `json:"displayName,omitempty"` + + IntColor *XPSColorMapIntColor `json:"intColor,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AnnotationSpecIdToken") 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. "AnnotationSpecIdToken") 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 *XPSColorMap) MarshalJSON() ([]byte, error) { + type NoMethod XPSColorMap + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSColorMapIntColor: RGB color and each channel is represented by an +// integer. +type XPSColorMapIntColor struct { + // Blue: The value should be in range of [0, 255]. + Blue int64 `json:"blue,omitempty"` + + // Green: The value should be in range of [0, 255]. + Green int64 `json:"green,omitempty"` + + // Red: The value should be in range of [0, 255]. + Red int64 `json:"red,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Blue") 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. "Blue") 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 *XPSColorMapIntColor) MarshalJSON() ([]byte, error) { + type NoMethod XPSColorMapIntColor + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSColumnSpec struct { + // ColumnId: The unique id of the column. When Preprocess, the Tables BE + // will popuate the order id of the column, which reflects the order of + // the column inside the table, i.e. 0 means the first column in the + // table, N-1 means the last column. AutoML BE will persist this order + // id in Spanner and set the order id here when calling + // RefreshTablesStats and Train. Note: it's different than the + // column_spec_id that is generated in AutoML BE. + ColumnId int64 `json:"columnId,omitempty"` + + // DataStats: The data stats of the column. It's outputed in + // RefreshTablesStats and a required input for Train. + DataStats *XPSDataStats `json:"dataStats,omitempty"` + + // DataType: The data type of the column. It's outputed in Preprocess + // rpc and a required input for RefreshTablesStats and Train. + DataType *XPSDataType `json:"dataType,omitempty"` + + // DisplayName: The display name of the column. It's outputed in + // Preprocess and a required input for RefreshTablesStats and Train. + DisplayName string `json:"displayName,omitempty"` + + ForecastingMetadata *XPSColumnSpecForecastingMetadata `json:"forecastingMetadata,omitempty"` + + // TopCorrelatedColumns: It's outputed in RefreshTablesStats, and a + // required input in Train. + TopCorrelatedColumns []*XPSColumnSpecCorrelatedColumn `json:"topCorrelatedColumns,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnId") 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. "ColumnId") 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 *XPSColumnSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSColumnSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSColumnSpecCorrelatedColumn: Identifies a table's column, and its +// correlation with the column this ColumnSpec describes. +type XPSColumnSpecCorrelatedColumn struct { + ColumnId int64 `json:"columnId,omitempty"` + + CorrelationStats *XPSCorrelationStats `json:"correlationStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnId") 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. "ColumnId") 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 *XPSColumnSpecCorrelatedColumn) MarshalJSON() ([]byte, error) { + type NoMethod XPSColumnSpecCorrelatedColumn + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSColumnSpecForecastingMetadata: +// ====================================================================== +// ===== # The fields below are used exclusively for Forecasting. +type XPSColumnSpecForecastingMetadata struct { + // ColumnType: The type of the column for FORECASTING model training + // purposes. + // + // Possible values: + // "COLUMN_TYPE_UNSPECIFIED" - An un-set value of this enum. + // "KEY" - Key columns are used to identify timeseries. + // "KEY_METADATA" - This column contains information describing static + // properties of the entities identified by the key column(s) (e.g. + // city's ZIP code). + // "TIME_SERIES_AVAILABLE_PAST_ONLY" - This column contains + // information for the given entity, at any time poinrt, they are only + // available in the time series before. + // "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" - This column contains + // information for the given entity is known both for the past and the + // sufficiently far future. + ColumnType string `json:"columnType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnType") 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. "ColumnType") 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 *XPSColumnSpecForecastingMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSColumnSpecForecastingMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSCommonStats: Common statistics for a column with a specified data +// type. +type XPSCommonStats struct { + DistinctValueCount int64 `json:"distinctValueCount,omitempty,string"` + + NullValueCount int64 `json:"nullValueCount,omitempty,string"` + + ValidValueCount int64 `json:"validValueCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DistinctValueCount") + // 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. "DistinctValueCount") 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 *XPSCommonStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCommonStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSConfidenceMetricsEntry: ConfidenceMetricsEntry includes generic +// precision, recall, f1 score etc. Next tag: 16. +type XPSConfidenceMetricsEntry struct { + // ConfidenceThreshold: Metrics are computed with an assumption that the + // model never return predictions with score lower than this value. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // F1ScoreAt1: The harmonic mean of recall_at1 and precision_at1. + F1ScoreAt1 float64 `json:"f1ScoreAt1,omitempty"` + + // FalseNegativeCount: The number of ground truth labels that are not + // matched by a model created label. + FalseNegativeCount int64 `json:"falseNegativeCount,omitempty,string"` + + // FalsePositiveCount: The number of model created labels that do not + // match a ground truth label. + FalsePositiveCount int64 `json:"falsePositiveCount,omitempty,string"` + + // FalsePositiveRate: False Positive Rate for the given confidence + // threshold. + FalsePositiveRate float64 `json:"falsePositiveRate,omitempty"` + + // FalsePositiveRateAt1: The False Positive Rate when only considering + // the label that has the highest prediction score and not below the + // confidence threshold for each example. + FalsePositiveRateAt1 float64 `json:"falsePositiveRateAt1,omitempty"` + + // PositionThreshold: Metrics are computed with an assumption that the + // model always returns at most this many predictions (ordered by their + // score, descendingly), but they all still need to meet the + // confidence_threshold. + PositionThreshold int64 `json:"positionThreshold,omitempty"` + + // Precision: Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // PrecisionAt1: The precision when only considering the label that has + // the highest prediction score and not below the confidence threshold + // for each example. + PrecisionAt1 float64 `json:"precisionAt1,omitempty"` + + // Recall: Recall (true positive rate) for the given confidence + // threshold. + Recall float64 `json:"recall,omitempty"` + + // RecallAt1: The recall (true positive rate) when only considering the + // label that has the highest prediction score and not below the + // confidence threshold for each example. + RecallAt1 float64 `json:"recallAt1,omitempty"` + + // TrueNegativeCount: The number of labels that were not created by the + // model, but if they would, they would not match a ground truth label. + TrueNegativeCount int64 `json:"trueNegativeCount,omitempty,string"` + + // TruePositiveCount: The number of model created labels that match a + // ground truth label. + TruePositiveCount int64 `json:"truePositiveCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + F1ScoreAt1 gensupport.JSONFloat64 `json:"f1ScoreAt1"` + FalsePositiveRate gensupport.JSONFloat64 `json:"falsePositiveRate"` + FalsePositiveRateAt1 gensupport.JSONFloat64 `json:"falsePositiveRateAt1"` + Precision gensupport.JSONFloat64 `json:"precision"` + PrecisionAt1 gensupport.JSONFloat64 `json:"precisionAt1"` + Recall gensupport.JSONFloat64 `json:"recall"` + RecallAt1 gensupport.JSONFloat64 `json:"recallAt1"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.F1ScoreAt1 = float64(s1.F1ScoreAt1) + s.FalsePositiveRate = float64(s1.FalsePositiveRate) + s.FalsePositiveRateAt1 = float64(s1.FalsePositiveRateAt1) + s.Precision = float64(s1.Precision) + s.PrecisionAt1 = float64(s1.PrecisionAt1) + s.Recall = float64(s1.Recall) + s.RecallAt1 = float64(s1.RecallAt1) + return nil +} + +// XPSConfusionMatrix: Confusion matrix of the model running the +// classification. +type XPSConfusionMatrix struct { + // AnnotationSpecIdToken: For the following three repeated fields, only + // one is intended to be set. annotation_spec_id_token is preferable to + // be set. ID tokens of the annotation specs used in the confusion + // matrix. + AnnotationSpecIdToken []string `json:"annotationSpecIdToken,omitempty"` + + // Category: Category (mainly for segmentation). Set only for image + // segmentation models. Note: uCAIP Image Segmentation should use + // annotation_spec_id_token. + Category []int64 `json:"category,omitempty"` + + // Row: Rows in the confusion matrix. The number of rows is equal to the + // size of `annotation_spec_id_token`. `row[i].value[j]` is the number + // of examples that have ground truth of the + // `annotation_spec_id_token[i]` and are predicted as + // `annotation_spec_id_token[j]` by the model being evaluated. + Row []*XPSConfusionMatrixRow `json:"row,omitempty"` + + // SentimentLabel: Sentiment labels used in the confusion matrix. Set + // only for text sentiment models. For AutoML Text Revamp, use + // `annotation_spec_id_token` instead and leave this field empty. + SentimentLabel []int64 `json:"sentimentLabel,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AnnotationSpecIdToken") 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. "AnnotationSpecIdToken") 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 *XPSConfusionMatrix) MarshalJSON() ([]byte, error) { + type NoMethod XPSConfusionMatrix + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSConfusionMatrixRow: A row in the confusion matrix. +type XPSConfusionMatrixRow struct { + // Count: Same as above except intended to represent other counts (for + // e.g. for segmentation this is pixel count). NOTE(params): Only + // example_count or count is set (oneoff does not support repeated + // fields unless they are embedded inside another message). + Count googleapi.Int64s `json:"count,omitempty"` + + // ExampleCount: Value of the specific cell in the confusion matrix. The + // number of values each row has (i.e. the length of the row) is equal + // to the length of the annotation_spec_id_token field. + ExampleCount []int64 `json:"exampleCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSConfusionMatrixRow) MarshalJSON() ([]byte, error) { + type NoMethod XPSConfusionMatrixRow + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSCoreMlFormat: A model format used for iOS mobile devices. +type XPSCoreMlFormat struct { +} + +// XPSCorrelationStats: A correlation statistics between two series of +// DataType values. The series may have differing DataType-s, but within +// a single series the DataType must be the same. +type XPSCorrelationStats struct { + // CramersV: The correlation value using the Cramer's V measure. + CramersV float64 `json:"cramersV,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CramersV") 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. "CramersV") 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 *XPSCorrelationStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCorrelationStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSCorrelationStats) UnmarshalJSON(data []byte) error { + type NoMethod XPSCorrelationStats + var s1 struct { + CramersV gensupport.JSONFloat64 `json:"cramersV"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.CramersV = float64(s1.CramersV) + return nil +} + +// XPSDataErrors: Different types of errors and the stats associatesd +// with each error. +type XPSDataErrors struct { + // Count: Number of records having errors associated with the enum. + Count int64 `json:"count,omitempty"` + + // ErrorType: Type of the error. + // + // Possible values: + // "ERROR_TYPE_UNSPECIFIED" - Not specified. + // "UNSUPPORTED_AUDIO_FORMAT" - Audio format not in the formats by + // cloud-speech AutoML. Currently only wav and flac file formats are + // supported. + // "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT" - File format differnt + // from what is specified in the file name extension. + // "FILE_TOO_LARGE" - File too large. Maximum allowed size is 50 MB. + // "MISSING_TRANSCRIPTION" - Transcript is missing. + ErrorType string `json:"errorType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSDataErrors) MarshalJSON() ([]byte, error) { + type NoMethod XPSDataErrors + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSDataStats: The data statistics of a series of values that share +// the same DataType. +type XPSDataStats struct { + // ArrayStats: The statistics for ARRAY DataType. + ArrayStats *XPSArrayStats `json:"arrayStats,omitempty"` + + // CategoryStats: The statistics for CATEGORY DataType. + CategoryStats *XPSCategoryStats `json:"categoryStats,omitempty"` + + // DistinctValueCount: The number of distinct values. + DistinctValueCount int64 `json:"distinctValueCount,omitempty,string"` + + // Float64Stats: The statistics for FLOAT64 DataType. + Float64Stats *XPSFloat64Stats `json:"float64Stats,omitempty"` + + // NullValueCount: The number of values that are null. + NullValueCount int64 `json:"nullValueCount,omitempty,string"` + + // StringStats: The statistics for STRING DataType. + StringStats *XPSStringStats `json:"stringStats,omitempty"` + + // StructStats: The statistics for STRUCT DataType. + StructStats *XPSStructStats `json:"structStats,omitempty"` + + // TimestampStats: The statistics for TIMESTAMP DataType. + TimestampStats *XPSTimestampStats `json:"timestampStats,omitempty"` + + // ValidValueCount: The number of values that are valid. + ValidValueCount int64 `json:"validValueCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ArrayStats") 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. "ArrayStats") 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 *XPSDataStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSDataStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSDataType: Indicated the type of data that can be stored in a +// structured data entity (e.g. a table). +type XPSDataType struct { + // CompatibleDataTypes: The highly compatible data types to this data + // type. + CompatibleDataTypes []*XPSDataType `json:"compatibleDataTypes,omitempty"` + + // ListElementType: If type_code == ARRAY, then `list_element_type` is + // the type of the elements. + ListElementType *XPSDataType `json:"listElementType,omitempty"` + + // Nullable: If true, this DataType can also be `null`. + Nullable bool `json:"nullable,omitempty"` + + // StructType: If type_code == STRUCT, then `struct_type` provides type + // information for the struct's fields. + StructType *XPSStructType `json:"structType,omitempty"` + + // TimeFormat: If type_code == TIMESTAMP then `time_format` provides the + // format in which that time field is expressed. The time_format must be + // written in `strftime` syntax. If time_format is not set, then the + // default format as described on the field is used. + TimeFormat string `json:"timeFormat,omitempty"` + + // TypeCode: Required. The TypeCode for this type. + // + // Possible values: + // "TYPE_CODE_UNSPECIFIED" - Not specified. Should not be used. + // "FLOAT64" - Encoded as `number`, or the strings "NaN", + // "Infinity", or "-Infinity". + // "TIMESTAMP" - Must be between 0AD and 9999AD. Encoded as `string` + // according to time_format, or, if that format is not set, then in RFC + // 3339 `date-time` format, where `time-offset` = "Z" (e.g. + // 1985-04-12T23:20:50.52Z). + // "STRING" - Encoded as `string`. + // "ARRAY" - Encoded as `list`, where the list elements are + // represented according to list_element_type. + // "STRUCT" - Encoded as `struct`, where field values are represented + // according to struct_type. + // "CATEGORY" - Values of this type are not further understood by + // AutoML, e.g. AutoML is unable to tell the order of values (as it + // could with FLOAT64), or is unable to say if one value contains + // another (as it could with STRING). Encoded as `string` (bytes should + // be base64-encoded, as described in RFC 4648, section 4). + TypeCode string `json:"typeCode,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CompatibleDataTypes") + // 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. "CompatibleDataTypes") 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 *XPSDataType) MarshalJSON() ([]byte, error) { + type NoMethod XPSDataType + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSDockerFormat: A model format used for Docker containers. Use the +// params field to customize the container. The container is verified to +// work correctly on ubuntu 16.04 operating system. +type XPSDockerFormat struct { + // CpuArchitecture: Optional. Additional cpu information describing the + // requirements for the to be exported model files. + // + // Possible values: + // "CPU_ARCHITECTURE_UNSPECIFIED" + // "CPU_ARCHITECTURE_X86_64" + CpuArchitecture string `json:"cpuArchitecture,omitempty"` + + // GpuArchitecture: Optional. Additional gpu information describing the + // requirements for the to be exported model files. + // + // Possible values: + // "GPU_ARCHITECTURE_UNSPECIFIED" + // "GPU_ARCHITECTURE_NVIDIA" + GpuArchitecture string `json:"gpuArchitecture,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CpuArchitecture") 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. "CpuArchitecture") 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 *XPSDockerFormat) MarshalJSON() ([]byte, error) { + type NoMethod XPSDockerFormat + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSEdgeTpuTfLiteFormat: A model format used for Edge TPU +// (https://cloud.google.com/edge-tpu/) devices. +type XPSEdgeTpuTfLiteFormat struct { +} + +// XPSEvaluationMetrics: Contains xPS-specific model evaluation metrics +// either for a single annotation spec (label), or for the model +// overall. Next tag: 18. +type XPSEvaluationMetrics struct { + // AnnotationSpecIdToken: The annotation_spec for which this evaluation + // metrics instance had been created. Empty iff this is an overall model + // evaluation (like Tables evaluation metrics), i.e. aggregated across + // all labels. The value comes from the input annotations in + // AnnotatedExample. For MVP product or for text sentiment models where + // annotation_spec_id_token is not available, set label instead. + AnnotationSpecIdToken string `json:"annotationSpecIdToken,omitempty"` + + // Category: The integer category label for which this evaluation metric + // instance had been created. Valid categories are 0 or higher. Overall + // model evaluation should set this to negative values (rather than + // implicit zero). Only used for Image Segmentation (prefer to set + // annotation_spec_id_token instead). Note: uCAIP Image Segmentation + // should use annotation_spec_id_token. + Category int64 `json:"category,omitempty"` + + // EvaluatedExampleCount: The number of examples used to create this + // evaluation metrics instance. + EvaluatedExampleCount int64 `json:"evaluatedExampleCount,omitempty"` + + ImageClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"imageClassificationEvalMetrics,omitempty"` + + ImageObjectDetectionEvalMetrics *XPSImageObjectDetectionEvaluationMetrics `json:"imageObjectDetectionEvalMetrics,omitempty"` + + ImageSegmentationEvalMetrics *XPSImageSegmentationEvaluationMetrics `json:"imageSegmentationEvalMetrics,omitempty"` + + // Label: The label for which this evaluation metrics instance had been + // created. Empty iff this is an overall model evaluation (like Tables + // evaluation metrics), i.e. aggregated across all labels. The label + // maps to AnnotationSpec.display_name in Public API protos. Only used + // by MVP implementation and text sentiment FULL implementation. + Label string `json:"label,omitempty"` + + RegressionEvalMetrics *XPSRegressionEvaluationMetrics `json:"regressionEvalMetrics,omitempty"` + + TablesClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"tablesClassificationEvalMetrics,omitempty"` + + TablesEvalMetrics *XPSTablesEvaluationMetrics `json:"tablesEvalMetrics,omitempty"` + + TextClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"textClassificationEvalMetrics,omitempty"` + + TextExtractionEvalMetrics *XPSTextExtractionEvaluationMetrics `json:"textExtractionEvalMetrics,omitempty"` + + TextSentimentEvalMetrics *XPSTextSentimentEvaluationMetrics `json:"textSentimentEvalMetrics,omitempty"` + + TranslationEvalMetrics *XPSTranslationEvaluationMetrics `json:"translationEvalMetrics,omitempty"` + + VideoActionRecognitionEvalMetrics *XPSVideoActionRecognitionEvaluationMetrics `json:"videoActionRecognitionEvalMetrics,omitempty"` + + VideoClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"videoClassificationEvalMetrics,omitempty"` + + VideoObjectTrackingEvalMetrics *XPSVideoObjectTrackingEvaluationMetrics `json:"videoObjectTrackingEvalMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AnnotationSpecIdToken") 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. "AnnotationSpecIdToken") 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 *XPSEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSEvaluationMetricsSet: Specifies location of model evaluation +// metrics. +type XPSEvaluationMetricsSet struct { + // EvaluationMetrics: Inline EvaluationMetrics - should be relatively + // small. For passing large quantities of exhaustive metrics, use + // file_spec. + EvaluationMetrics []*XPSEvaluationMetrics `json:"evaluationMetrics,omitempty"` + + // FileSpec: File spec containing evaluation metrics of a model, must + // point to RecordIO file(s) of + // intelligence.cloud.automl.xps.EvaluationMetrics messages. + FileSpec *XPSFileSpec `json:"fileSpec,omitempty"` + + // NumEvaluationMetrics: Number of the evaluation metrics (usually one + // per label plus overall). + NumEvaluationMetrics int64 `json:"numEvaluationMetrics,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "EvaluationMetrics") + // 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. "EvaluationMetrics") 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 *XPSEvaluationMetricsSet) MarshalJSON() ([]byte, error) { + type NoMethod XPSEvaluationMetricsSet + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSExampleSet: Set of examples or input sources. +type XPSExampleSet struct { + // FileSpec: File spec of the examples or input sources. + FileSpec *XPSFileSpec `json:"fileSpec,omitempty"` + + // Fingerprint: Fingerprint of the example set. + Fingerprint int64 `json:"fingerprint,omitempty,string"` + + // NumExamples: Number of examples. + NumExamples int64 `json:"numExamples,omitempty,string"` + + // NumInputSources: Number of input sources. + NumInputSources int64 `json:"numInputSources,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "FileSpec") 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. "FileSpec") 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 *XPSExampleSet) MarshalJSON() ([]byte, error) { + type NoMethod XPSExampleSet + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSExportModelOutputConfig struct { + CoreMlFormat *XPSCoreMlFormat `json:"coreMlFormat,omitempty"` + + DockerFormat *XPSDockerFormat `json:"dockerFormat,omitempty"` + + EdgeTpuTfLiteFormat *XPSEdgeTpuTfLiteFormat `json:"edgeTpuTfLiteFormat,omitempty"` + + // ExportFirebaseAuxiliaryInfo: For any model and format: If true, will + // additionally export FirebaseExportedModelInfo in a firebase.txt file. + ExportFirebaseAuxiliaryInfo bool `json:"exportFirebaseAuxiliaryInfo,omitempty"` + + // OutputGcrUri: The Google Contained Registry (GCR) path the exported + // files to be pushed to. This location is set if the exported format is + // DOCKDER. + OutputGcrUri string `json:"outputGcrUri,omitempty"` + + // OutputGcsUri: The Google Cloud Storage (GCS) directory where XPS will + // output the exported models and related files. Format: + // gs://bucket/directory + OutputGcsUri string `json:"outputGcsUri,omitempty"` + + TfJsFormat *XPSTfJsFormat `json:"tfJsFormat,omitempty"` + + TfLiteFormat *XPSTfLiteFormat `json:"tfLiteFormat,omitempty"` + + TfSavedModelFormat *XPSTfSavedModelFormat `json:"tfSavedModelFormat,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CoreMlFormat") 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. "CoreMlFormat") 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 *XPSExportModelOutputConfig) MarshalJSON() ([]byte, error) { + type NoMethod XPSExportModelOutputConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSFileSpec: Spec of input and output files, on external file systems +// (CNS, GCS, etc). +type XPSFileSpec struct { + // DirectoryPath: Deprecated. Use file_spec. + DirectoryPath string `json:"directoryPath,omitempty"` + + // Possible values: + // "FILE_FORMAT_UNKNOWN" + // "FILE_FORMAT_SSTABLE" + // "FILE_FORMAT_TRANSLATION_RKV" - Internal format for parallel text + // data used by Google Translate. go/rkvtools + // "FILE_FORMAT_RECORDIO" + // "FILE_FORMAT_RAW_CSV" - Only the lexicographically first file + // described by the file_spec contains the header line. + // "FILE_FORMAT_RAW_CAPACITOR" + FileFormat string `json:"fileFormat,omitempty"` + + // FileSpec: Single file path, or file pattern of format + // "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is + // expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and + // /cns/cell-d/somewhere/file-00001-of-00002. + FileSpec string `json:"fileSpec,omitempty"` + + // SingleFilePath: Deprecated. Use file_spec. + SingleFilePath string `json:"singleFilePath,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DirectoryPath") 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. "DirectoryPath") 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 *XPSFileSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSFileSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSFloat64Stats: The data statistics of a series of FLOAT64 values. +type XPSFloat64Stats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // HistogramBuckets: Histogram buckets of the data series. Sorted by the + // min value of the bucket, ascendingly, and the number of the buckets + // is dynamically generated. The buckets are non-overlapping and + // completely cover whole FLOAT64 range with min of first bucket being + // "-Infinity", and max of the last one being "Infinity". + HistogramBuckets []*XPSFloat64StatsHistogramBucket `json:"histogramBuckets,omitempty"` + + // Mean: The mean of the series. + Mean float64 `json:"mean,omitempty"` + + // Quantiles: Ordered from 0 to k k-quantile values of the data series + // of n values. The value at index i is, approximately, the i*n/k-th + // smallest value in the series; for i = 0 and i = k these are, + // respectively, the min and max values. + Quantiles []float64 `json:"quantiles,omitempty"` + + // StandardDeviation: The standard deviation of the series. + StandardDeviation float64 `json:"standardDeviation,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSFloat64Stats) MarshalJSON() ([]byte, error) { + type NoMethod XPSFloat64Stats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSFloat64Stats) UnmarshalJSON(data []byte) error { + type NoMethod XPSFloat64Stats + var s1 struct { + Mean gensupport.JSONFloat64 `json:"mean"` + Quantiles []gensupport.JSONFloat64 `json:"quantiles"` + StandardDeviation gensupport.JSONFloat64 `json:"standardDeviation"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Mean = float64(s1.Mean) + s.Quantiles = make([]float64, len(s1.Quantiles)) + for i := range s1.Quantiles { + s.Quantiles[i] = float64(s1.Quantiles[i]) + } + s.StandardDeviation = float64(s1.StandardDeviation) + return nil +} + +// XPSFloat64StatsHistogramBucket: A bucket of a histogram. +type XPSFloat64StatsHistogramBucket struct { + // Count: The number of data values that are in the bucket, i.e. are + // between min and max values. + Count int64 `json:"count,omitempty,string"` + + // Max: The maximum value of the bucket, exclusive unless max = + // "Infinity", in which case it's inclusive. + Max float64 `json:"max,omitempty"` + + // Min: The minimum value of the bucket, inclusive. + Min float64 `json:"min,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSFloat64StatsHistogramBucket) MarshalJSON() ([]byte, error) { + type NoMethod XPSFloat64StatsHistogramBucket + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSFloat64StatsHistogramBucket) UnmarshalJSON(data []byte) error { + type NoMethod XPSFloat64StatsHistogramBucket + var s1 struct { + Max gensupport.JSONFloat64 `json:"max"` + Min gensupport.JSONFloat64 `json:"min"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Max = float64(s1.Max) + s.Min = float64(s1.Min) + return nil +} + +type XPSImageClassificationTrainResponse struct { + // ClassCount: Total number of classes. + ClassCount int64 `json:"classCount,omitempty,string"` + + // ExportModelSpec: Information of downloadable models that are + // pre-generated as part of training flow and will be persisted in + // AutoMl backend. Populated for AutoMl requests. + ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` + + // StopReason: Stop reason for training job, e.g. + // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + // + // Possible values: + // "TRAIN_STOP_REASON_UNSPECIFIED" + // "TRAIN_STOP_REASON_BUDGET_REACHED" + // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can + // not be resumbed training. + // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, + // can be further trained till full convergency. + StopReason string `json:"stopReason,omitempty"` + + // TrainCostInNodeTime: The actual cost to create this model. - For edge + // type model, the cost is expressed in node hour. - For cloud type + // model,the cost is expressed in compute hour. - Populated for models + // created before GA. To be deprecated after GA. + TrainCostInNodeTime string `json:"trainCostInNodeTime,omitempty"` + + // TrainCostNodeSeconds: The actual training cost, expressed in node + // seconds. Populated for models trained in node time. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ClassCount") 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. "ClassCount") 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 *XPSImageClassificationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageClassificationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageExportModelSpec: Information of downloadable models that are +// pre-generated as part of training flow and will be persisted in +// AutoMl backend. Upon receiving ExportModel request from user, AutoMl +// backend can serve the pre-generated models to user if exists (by +// copying the files from internal path to user provided location), +// otherwise, AutoMl backend will call xPS ExportModel API to generate +// the model on the fly with the requesting format. +type XPSImageExportModelSpec struct { + // ExportModelOutputConfig: Contains the model format and internal + // location of the model files to be exported/downloaded. Use the GCS + // bucket name which is provided via TrainRequest.gcs_bucket_name to + // store the model files. + ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ExportModelOutputConfig") 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. "ExportModelOutputConfig") + // 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 *XPSImageExportModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageExportModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageModelArtifactSpec: Stores the locations and related metadata +// of the model artifacts. Populated for uCAIP requests only. +type XPSImageModelArtifactSpec struct { + // CheckpointArtifact: The Tensorflow checkpoint files. e.g. Used for + // resumable training. + CheckpointArtifact *XPSModelArtifactItem `json:"checkpointArtifact,omitempty"` + + // ExportArtifact: The model binary files in different formats for model + // export. + ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` + + // LabelGcsUri: GCS uri of decoded labels file for model export + // 'dict.txt'. + LabelGcsUri string `json:"labelGcsUri,omitempty"` + + // ServingArtifact: The default model binary file used for serving (e.g. + // online predict, batch predict) via public Cloud AI Platform API. + ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` + + // TfJsBinaryGcsPrefix: GCS uri prefix of Tensorflow JavaScript binary + // files 'groupX-shardXofX.bin' Deprecated. + TfJsBinaryGcsPrefix string `json:"tfJsBinaryGcsPrefix,omitempty"` + + // TfLiteMetadataGcsUri: GCS uri of Tensorflow Lite metadata + // 'tflite_metadata.json'. + TfLiteMetadataGcsUri string `json:"tfLiteMetadataGcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CheckpointArtifact") + // 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. "CheckpointArtifact") 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 *XPSImageModelArtifactSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageModelArtifactSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageModelServingSpec: Serving specification for image models. +type XPSImageModelServingSpec struct { + // ModelThroughputEstimation: Populate under uCAIP request scope. + ModelThroughputEstimation []*XPSImageModelServingSpecModelThroughputEstimation `json:"modelThroughputEstimation,omitempty"` + + // NodeQps: An estimated value of how much traffic a node can serve. + // Populated for AutoMl request only. + NodeQps float64 `json:"nodeQps,omitempty"` + + // TfRuntimeVersion: ## The fields below are only populated under uCAIP + // request scope. + // https://cloud.google.com/ml-engine/docs/runtime-version-list + TfRuntimeVersion string `json:"tfRuntimeVersion,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ModelThroughputEstimation") 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. + // "ModelThroughputEstimation") 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 *XPSImageModelServingSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageModelServingSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageModelServingSpec) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageModelServingSpec + var s1 struct { + NodeQps gensupport.JSONFloat64 `json:"nodeQps"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.NodeQps = float64(s1.NodeQps) + return nil +} + +type XPSImageModelServingSpecModelThroughputEstimation struct { + // Possible values: + // "UNSPECIFIED" + // "NVIDIA_TESLA_K80" - Nvidia Tesla K80 GPU. + // "NVIDIA_TESLA_P100" - Nvidia Tesla P100 GPU. + // "NVIDIA_TESLA_V100" - Nvidia Tesla V100 GPU. + // "NVIDIA_TESLA_P4" - Nvidia Tesla P4 GPU. + // "NVIDIA_TESLA_T4" - Nvidia Tesla T4 GPU. + // "NVIDIA_TESLA_A100" - Nvidia Tesla A100 GPU. + // "NVIDIA_A100_80GB" - Nvidia A100 80GB GPU. + // "NVIDIA_L4" - Nvidia L4 GPU. + // "NVIDIA_H100_80GB" - Nvidia H100 80Gb GPU. + // "TPU_V2" - TPU v2 (JellyFish). + // "TPU_V3" - TPU v3 (DragonFish). + // "TPU_V4_POD" - TPU_v4 (PufferFish). + // "TPU_V5_LITEPOD" - TPU v5 Lite Pods. + ComputeEngineAcceleratorType string `json:"computeEngineAcceleratorType,omitempty"` + + // LatencyInMilliseconds: Estimated latency. + LatencyInMilliseconds float64 `json:"latencyInMilliseconds,omitempty"` + + // NodeQps: The approximate qps a deployed node can serve. + NodeQps float64 `json:"nodeQps,omitempty"` + + // Possible values: + // "PARTITION_TYPE_UNSPECIFIED" + // "PARTITION_ZERO" - The default partition. + // "PARTITION_REDUCED_HOMING" - It has significantly lower replication + // than partition-0 and is located in the US only. It also has a larger + // model size limit and higher default RAM quota than partition-0. + // Customers with batch traffic, US-based traffic, or very large models + // should use this partition. Capacity in this partition is + // significantly cheaper than partition-0. + // "PARTITION_JELLYFISH" - To be used by customers with + // Jellyfish-accelerated ops. See go/servomatic-jellyfish for details. + // "PARTITION_CPU" - The partition used by regionalized servomatic + // cloud regions. + // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading + // models from custom storage. + ServomaticPartitionType string `json:"servomaticPartitionType,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ComputeEngineAcceleratorType") 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. + // "ComputeEngineAcceleratorType") 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 *XPSImageModelServingSpecModelThroughputEstimation) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageModelServingSpecModelThroughputEstimation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageModelServingSpecModelThroughputEstimation) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageModelServingSpecModelThroughputEstimation + var s1 struct { + LatencyInMilliseconds gensupport.JSONFloat64 `json:"latencyInMilliseconds"` + NodeQps gensupport.JSONFloat64 `json:"nodeQps"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LatencyInMilliseconds = float64(s1.LatencyInMilliseconds) + s.NodeQps = float64(s1.NodeQps) + return nil +} + +// XPSImageObjectDetectionEvaluationMetrics: Model evaluation metrics +// for image object detection problems. Evaluates prediction quality of +// labeled bounding boxes. +type XPSImageObjectDetectionEvaluationMetrics struct { + // BoundingBoxMeanAveragePrecision: The single metric for bounding boxes + // evaluation: the mean_average_precision averaged over all + // bounding_box_metrics_entries. + BoundingBoxMeanAveragePrecision float64 `json:"boundingBoxMeanAveragePrecision,omitempty"` + + // BoundingBoxMetricsEntries: The bounding boxes match metrics for each + // Intersection-over-union threshold + // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence + // threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + BoundingBoxMetricsEntries []*XPSBoundingBoxMetricsEntry `json:"boundingBoxMetricsEntries,omitempty"` + + // EvaluatedBoundingBoxCount: The total number of bounding boxes (i.e. + // summed over all images) the ground truth used to create this + // evaluation had. + EvaluatedBoundingBoxCount int64 `json:"evaluatedBoundingBoxCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BoundingBoxMeanAveragePrecision") 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. + // "BoundingBoxMeanAveragePrecision") 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 *XPSImageObjectDetectionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageObjectDetectionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageObjectDetectionEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageObjectDetectionEvaluationMetrics + var s1 struct { + BoundingBoxMeanAveragePrecision gensupport.JSONFloat64 `json:"boundingBoxMeanAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BoundingBoxMeanAveragePrecision = float64(s1.BoundingBoxMeanAveragePrecision) + return nil +} + +type XPSImageObjectDetectionModelSpec struct { + // ClassCount: Total number of classes. + ClassCount int64 `json:"classCount,omitempty,string"` + + ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` + + // MaxBoundingBoxCount: Max number of bounding box. + MaxBoundingBoxCount int64 `json:"maxBoundingBoxCount,omitempty,string"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` + + // StopReason: Stop reason for training job, e.g. + // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + // + // Possible values: + // "TRAIN_STOP_REASON_UNSPECIFIED" + // "TRAIN_STOP_REASON_BUDGET_REACHED" + // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can + // not be resumbed training. + // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, + // can be further trained till full convergency. + StopReason string `json:"stopReason,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ClassCount") 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. "ClassCount") 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 *XPSImageObjectDetectionModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageObjectDetectionModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageSegmentationEvaluationMetrics: Model evaluation metrics for +// image segmentation problems. Next tag: 4. +type XPSImageSegmentationEvaluationMetrics struct { + // ConfidenceMetricsEntries: Metrics that have confidence thresholds. + // Precision-recall curve can be derived from it. + ConfidenceMetricsEntries []*XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSImageSegmentationEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageSegmentationEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: Metrics +// for a single confidence threshold. +type XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry struct { + // ConfidenceThreshold: The confidence threshold value used to compute + // the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // ConfusionMatrix: Confusion matrix of the per confidence_threshold + // evaluation. Pixel counts are set here. Only set for model level + // evaluation, not for evaluation per label. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // DiceScoreCoefficient: DSC or the F1 score: The harmonic mean of + // recall and precision. + DiceScoreCoefficient float64 `json:"diceScoreCoefficient,omitempty"` + + // IouScore: IOU score. + IouScore float64 `json:"iouScore,omitempty"` + + // Precision: Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // Recall: Recall for the given confidence threshold. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + DiceScoreCoefficient gensupport.JSONFloat64 `json:"diceScoreCoefficient"` + IouScore gensupport.JSONFloat64 `json:"iouScore"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.DiceScoreCoefficient = float64(s1.DiceScoreCoefficient) + s.IouScore = float64(s1.IouScore) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + return nil +} + +type XPSImageSegmentationTrainResponse struct { + // ColorMaps: Color map of the model. + ColorMaps []*XPSColorMap `json:"colorMaps,omitempty"` + + // ExportModelSpec: NOTE: These fields are not used/needed in EAP but + // will be set later. + ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. Model artifact spec stores and model gcs pathes and + // related metadata + ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` + + // StopReason: Stop reason for training job, e.g. + // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + // + // Possible values: + // "TRAIN_STOP_REASON_UNSPECIFIED" + // "TRAIN_STOP_REASON_BUDGET_REACHED" + // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can + // not be resumbed training. + // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, + // can be further trained till full convergency. + StopReason string `json:"stopReason,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ColorMaps") 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. "ColorMaps") 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 *XPSImageSegmentationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageSegmentationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSIntegratedGradientsAttribution: An attribution method that +// computes the Aumann-Shapley value taking advantage of the model's +// fully differentiable structure. Refer to this paper for more details: +// https://arxiv.org/abs/1703.01365 +type XPSIntegratedGradientsAttribution struct { + // StepCount: The number of steps for approximating the path integral. A + // good value to start is 50 and gradually increase until the sum to + // diff property is within the desired error range. Valid range of its + // value is [1, 100], inclusively. + StepCount int64 `json:"stepCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "StepCount") 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. "StepCount") 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 *XPSIntegratedGradientsAttribution) MarshalJSON() ([]byte, error) { + type NoMethod XPSIntegratedGradientsAttribution + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSMetricEntry struct { + // ArgentumMetricId: For billing metrics that are using legacy sku's, + // set the legacy billing metric id here. This will be sent to Chemist + // as the "cloudbilling.googleapis.com/argentum_metric_id" label. + // Otherwise leave empty. + ArgentumMetricId string `json:"argentumMetricId,omitempty"` + + // DoubleValue: A double value. + DoubleValue float64 `json:"doubleValue,omitempty"` + + // Int64Value: A signed 64-bit integer value. + Int64Value int64 `json:"int64Value,omitempty,string"` + + // MetricName: The metric name defined in the service configuration. + MetricName string `json:"metricName,omitempty"` + + // SystemLabels: Billing system labels for this (metric, value) pair. + SystemLabels []*XPSMetricEntryLabel `json:"systemLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ArgentumMetricId") 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. "ArgentumMetricId") 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 *XPSMetricEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSMetricEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSMetricEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSMetricEntry + var s1 struct { + DoubleValue gensupport.JSONFloat64 `json:"doubleValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.DoubleValue = float64(s1.DoubleValue) + return nil +} + +type XPSMetricEntryLabel struct { + // LabelName: The name of the label. + LabelName string `json:"labelName,omitempty"` + + // LabelValue: The value of the label. + LabelValue string `json:"labelValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "LabelName") 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. "LabelName") 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 *XPSMetricEntryLabel) MarshalJSON() ([]byte, error) { + type NoMethod XPSMetricEntryLabel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSModelArtifactItem: A single model artifact item. +type XPSModelArtifactItem struct { + // ArtifactFormat: The model artifact format. + // + // Possible values: + // "ARTIFACT_FORMAT_UNSPECIFIED" - Should not be used. + // "TF_CHECKPOINT" - The Tensorflow checkpoints. See + // https://www.tensorflow.org/guide/checkpoint. + // "TF_SAVED_MODEL" - The Tensorflow SavedModel binary. + // "TF_LITE" - Model artifact in generic TensorFlow Lite (.tflite) + // format. See https://www.tensorflow.org/lite. + // "EDGE_TPU_TF_LITE" - Used for [Edge + // TPU](https://cloud.google.com/edge-tpu/) devices. + // "TF_JS" - A [TensorFlow.js](https://www.tensorflow.org/js) model + // that can be used in the browser and in Node.js using JavaScript. + // "CORE_ML" - Used for iOS mobile devices in (.mlmodel) format. See + // https://developer.apple.com/documentation/coreml + ArtifactFormat string `json:"artifactFormat,omitempty"` + + // GcsUri: The Google Cloud Storage (GCS) uri that stores the model + // binary files. + GcsUri string `json:"gcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ArtifactFormat") 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. "ArtifactFormat") 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 *XPSModelArtifactItem) MarshalJSON() ([]byte, error) { + type NoMethod XPSModelArtifactItem + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSPreprocessResponse: Next ID: 8 +type XPSPreprocessResponse struct { + // OutputExampleSet: Preprocessed examples, that are to be imported into + // AutoML storage. This should point to RecordIO file(s) of + // PreprocessedExample messages. The + // PreprocessedExample.mvp_training_data-s returned here are later + // verbatim passed to Train() call in TrainExample.mvp_training_data. + OutputExampleSet *XPSExampleSet `json:"outputExampleSet,omitempty"` + + SpeechPreprocessResp *XPSSpeechPreprocessResponse `json:"speechPreprocessResp,omitempty"` + + TablesPreprocessResponse *XPSTablesPreprocessResponse `json:"tablesPreprocessResponse,omitempty"` + + TranslationPreprocessResp *XPSTranslationPreprocessResponse `json:"translationPreprocessResp,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OutputExampleSet") 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. "OutputExampleSet") 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 *XPSPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSRegressionEvaluationMetrics: Model evaluation metrics for +// regression problems. It can be used for Tables. +type XPSRegressionEvaluationMetrics struct { + // MeanAbsoluteError: Mean Absolute Error (MAE). + MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` + + // MeanAbsolutePercentageError: Mean absolute percentage error. Only set + // if all ground truth values are positive. + MeanAbsolutePercentageError float64 `json:"meanAbsolutePercentageError,omitempty"` + + // RSquared: R squared. + RSquared float64 `json:"rSquared,omitempty"` + + // RegressionMetricsEntries: A list of actual versus predicted points + // for the model being evaluated. + RegressionMetricsEntries []*XPSRegressionMetricsEntry `json:"regressionMetricsEntries,omitempty"` + + // RootMeanSquaredError: Root Mean Squared Error (RMSE). + RootMeanSquaredError float64 `json:"rootMeanSquaredError,omitempty"` + + // RootMeanSquaredLogError: Root mean squared log error. + RootMeanSquaredLogError float64 `json:"rootMeanSquaredLogError,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MeanAbsoluteError") + // 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. "MeanAbsoluteError") 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 *XPSRegressionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSRegressionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSRegressionEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSRegressionEvaluationMetrics + var s1 struct { + MeanAbsoluteError gensupport.JSONFloat64 `json:"meanAbsoluteError"` + MeanAbsolutePercentageError gensupport.JSONFloat64 `json:"meanAbsolutePercentageError"` + RSquared gensupport.JSONFloat64 `json:"rSquared"` + RootMeanSquaredError gensupport.JSONFloat64 `json:"rootMeanSquaredError"` + RootMeanSquaredLogError gensupport.JSONFloat64 `json:"rootMeanSquaredLogError"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.MeanAbsoluteError = float64(s1.MeanAbsoluteError) + s.MeanAbsolutePercentageError = float64(s1.MeanAbsolutePercentageError) + s.RSquared = float64(s1.RSquared) + s.RootMeanSquaredError = float64(s1.RootMeanSquaredError) + s.RootMeanSquaredLogError = float64(s1.RootMeanSquaredLogError) + return nil +} + +// XPSRegressionMetricsEntry: A pair of actual & observed values for the +// model being evaluated. +type XPSRegressionMetricsEntry struct { + // PredictedValue: The observed value for a row in the dataset. + PredictedValue float64 `json:"predictedValue,omitempty"` + + // TrueValue: The actual target value for a row in the dataset. + TrueValue float64 `json:"trueValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "PredictedValue") 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. "PredictedValue") 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 *XPSRegressionMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSRegressionMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSRegressionMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSRegressionMetricsEntry + var s1 struct { + PredictedValue gensupport.JSONFloat64 `json:"predictedValue"` + TrueValue gensupport.JSONFloat64 `json:"trueValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.PredictedValue = float64(s1.PredictedValue) + s.TrueValue = float64(s1.TrueValue) + return nil +} + +type XPSReportingMetrics struct { + // EffectiveTrainingDuration: The effective time training used. If set, + // this is used for quota management and billing. Deprecated. AutoML BE + // doesn't use this. Don't set. + EffectiveTrainingDuration string `json:"effectiveTrainingDuration,omitempty"` + + // MetricEntries: One entry per metric name. The values must be + // aggregated per metric name. + MetricEntries []*XPSMetricEntry `json:"metricEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EffectiveTrainingDuration") 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. + // "EffectiveTrainingDuration") 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 *XPSReportingMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSReportingMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSResponseExplanationMetadata struct { + // Inputs: Metadata of the input. + Inputs map[string]XPSResponseExplanationMetadataInputMetadata `json:"inputs,omitempty"` + + // Outputs: Metadata of the output. + Outputs map[string]XPSResponseExplanationMetadataOutputMetadata `json:"outputs,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Inputs") 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. "Inputs") 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 *XPSResponseExplanationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSResponseExplanationMetadataInputMetadata: Metadata of the input of +// a feature. +type XPSResponseExplanationMetadataInputMetadata struct { + // InputTensorName: Name of the input tensor for this model. Only needed + // in train response. + InputTensorName string `json:"inputTensorName,omitempty"` + + // Modality: Modality of the feature. Valid values are: numeric, image. + // Defaults to numeric. + // + // Possible values: + // "MODALITY_UNSPECIFIED" + // "NUMERIC" + // "IMAGE" + // "CATEGORICAL" + Modality string `json:"modality,omitempty"` + + // VisualizationConfig: Visualization configurations for image + // explanation. + VisualizationConfig *XPSVisualization `json:"visualizationConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputTensorName") 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. "InputTensorName") 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 *XPSResponseExplanationMetadataInputMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationMetadataInputMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSResponseExplanationMetadataOutputMetadata: Metadata of the +// prediction output to be explained. +type XPSResponseExplanationMetadataOutputMetadata struct { + // OutputTensorName: Name of the output tensor. Only needed in train + // response. + OutputTensorName string `json:"outputTensorName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OutputTensorName") 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. "OutputTensorName") 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 *XPSResponseExplanationMetadataOutputMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationMetadataOutputMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSResponseExplanationParameters struct { + // IntegratedGradientsAttribution: An attribution method that computes + // Aumann-Shapley values taking advantage of the model's fully + // differentiable structure. Refer to this paper for more details: + // https://arxiv.org/abs/1703.01365 + IntegratedGradientsAttribution *XPSIntegratedGradientsAttribution `json:"integratedGradientsAttribution,omitempty"` + + // XraiAttribution: An attribution method that redistributes Integrated + // Gradients attribution to segmented regions, taking advantage of the + // model's fully differentiable structure. Refer to this paper for more + // details: https://arxiv.org/abs/1906.02825 XRAI currently performs + // better on natural images, like a picture of a house or an animal. If + // the images are taken in artificial environments, like a lab or + // manufacturing line, or from diagnostic equipment, like x-rays or + // quality-control cameras, use Integrated Gradients instead. + XraiAttribution *XPSXraiAttribution `json:"xraiAttribution,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "IntegratedGradientsAttribution") 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. + // "IntegratedGradientsAttribution") 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 *XPSResponseExplanationParameters) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationParameters + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSResponseExplanationSpec: Specification of Model explanation. +// Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 +// for context. +type XPSResponseExplanationSpec struct { + // ExplanationType: Explanation type. For AutoML Image Classification + // models, possible values are: * `image-integrated-gradients` * + // `image-xrai` + ExplanationType string `json:"explanationType,omitempty"` + + // Metadata: Metadata describing the Model's input and output for + // explanation. + Metadata *XPSResponseExplanationMetadata `json:"metadata,omitempty"` + + // Parameters: Parameters that configure explaining of the Model's + // predictions. + Parameters *XPSResponseExplanationParameters `json:"parameters,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExplanationType") 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. "ExplanationType") 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 *XPSResponseExplanationSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSRow struct { + // ColumnIds: The ids of the columns. Note: The below `values` field + // must match order of this field, if this field is set. + ColumnIds []int64 `json:"columnIds,omitempty"` + + // Values: The values of the row cells, given in the same order as the + // column_ids. If column_ids is not set, then in the same order as the + // input_feature_column_ids in TablesModelMetadata. + Values []interface{} `json:"values,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnIds") 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. "ColumnIds") 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 *XPSRow) MarshalJSON() ([]byte, error) { + type NoMethod XPSRow + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechEvaluationMetrics struct { + // SubModelEvaluationMetrics: Evaluation metrics for all submodels + // contained in this model. + SubModelEvaluationMetrics []*XPSSpeechEvaluationMetricsSubModelEvaluationMetric `json:"subModelEvaluationMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "SubModelEvaluationMetrics") 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. + // "SubModelEvaluationMetrics") 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 *XPSSpeechEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechEvaluationMetricsSubModelEvaluationMetric struct { + // BiasingModelType: Type of the biasing model. + // + // Possible values: + // "BIASING_MODEL_TYPE_UNSPECIFIED" + // "COMMAND_AND_SEARCH" - Build biasing model on top of + // COMMAND_AND_SEARCH model + // "PHONE_CALL" - Build biasing model on top of PHONE_CALL model + // "VIDEO" - Build biasing model on top of VIDEO model + // "DEFAULT" - Build biasing model on top of DEFAULT model + BiasingModelType string `json:"biasingModelType,omitempty"` + + // IsEnhancedModel: If true then it means we have an enhanced version of + // the biasing models. + IsEnhancedModel bool `json:"isEnhancedModel,omitempty"` + + NumDeletions int64 `json:"numDeletions,omitempty"` + + NumInsertions int64 `json:"numInsertions,omitempty"` + + NumSubstitutions int64 `json:"numSubstitutions,omitempty"` + + // NumUtterances: Number of utterances used in the wer computation. + NumUtterances int64 `json:"numUtterances,omitempty"` + + // NumWords: Number of words over which the word error rate was + // computed. + NumWords int64 `json:"numWords,omitempty"` + + // SentenceAccuracy: Below fields are used for debugging purposes + SentenceAccuracy float64 `json:"sentenceAccuracy,omitempty"` + + // Wer: Word error rate (standard error metric used for speech + // recognition). + Wer float64 `json:"wer,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BiasingModelType") 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. "BiasingModelType") 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 *XPSSpeechEvaluationMetricsSubModelEvaluationMetric) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechEvaluationMetricsSubModelEvaluationMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSSpeechEvaluationMetricsSubModelEvaluationMetric) UnmarshalJSON(data []byte) error { + type NoMethod XPSSpeechEvaluationMetricsSubModelEvaluationMetric + var s1 struct { + SentenceAccuracy gensupport.JSONFloat64 `json:"sentenceAccuracy"` + Wer gensupport.JSONFloat64 `json:"wer"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SentenceAccuracy = float64(s1.SentenceAccuracy) + s.Wer = float64(s1.Wer) + return nil +} + +type XPSSpeechModelSpec struct { + // DatasetId: Required for speech xps backend. Speech xps has to use + // dataset_id and model_id as the primary key in db so that speech API + // can query the db directly. + DatasetId int64 `json:"datasetId,omitempty,string"` + + Language string `json:"language,omitempty"` + + // SubModelSpecs: Model specs for all submodels contained in this model. + SubModelSpecs []*XPSSpeechModelSpecSubModelSpec `json:"subModelSpecs,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DatasetId") 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. "DatasetId") 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 *XPSSpeechModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechModelSpecSubModelSpec struct { + // BiasingModelType: Type of the biasing model. + // + // Possible values: + // "BIASING_MODEL_TYPE_UNSPECIFIED" + // "COMMAND_AND_SEARCH" - Build biasing model on top of + // COMMAND_AND_SEARCH model + // "PHONE_CALL" - Build biasing model on top of PHONE_CALL model + // "VIDEO" - Build biasing model on top of VIDEO model + // "DEFAULT" - Build biasing model on top of DEFAULT model + BiasingModelType string `json:"biasingModelType,omitempty"` + + // ClientId: In S3, Recognition ClientContextId.client_id + ClientId string `json:"clientId,omitempty"` + + // ContextId: In S3, Recognition ClientContextId.context_id + ContextId string `json:"contextId,omitempty"` + + // IsEnhancedModel: If true then it means we have an enhanced version of + // the biasing models. + IsEnhancedModel bool `json:"isEnhancedModel,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BiasingModelType") 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. "BiasingModelType") 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 *XPSSpeechModelSpecSubModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechModelSpecSubModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechPreprocessResponse struct { + // CnsTestDataPath: Location od shards of sstables (test data) of + // DataUtterance protos. + CnsTestDataPath string `json:"cnsTestDataPath,omitempty"` + + // CnsTrainDataPath: Location of shards of sstables (training data) of + // DataUtterance protos. + CnsTrainDataPath string `json:"cnsTrainDataPath,omitempty"` + + // PrebuiltModelEvaluationMetrics: The metrics for prebuilt speech + // models. They are included here because there is no prebuilt speech + // models stored in the AutoML. + PrebuiltModelEvaluationMetrics *XPSSpeechEvaluationMetrics `json:"prebuiltModelEvaluationMetrics,omitempty"` + + // SpeechPreprocessStats: Stats associated with the data. + SpeechPreprocessStats *XPSSpeechPreprocessStats `json:"speechPreprocessStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CnsTestDataPath") 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. "CnsTestDataPath") 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 *XPSSpeechPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechPreprocessStats struct { + // DataErrors: Different types of data errors and the counts associated + // with them. + DataErrors []*XPSDataErrors `json:"dataErrors,omitempty"` + + // NumHumanLabeledExamples: The number of rows marked HUMAN_LABELLED + NumHumanLabeledExamples int64 `json:"numHumanLabeledExamples,omitempty"` + + // NumLogsExamples: The number of samples found in the previously + // recorded logs data. + NumLogsExamples int64 `json:"numLogsExamples,omitempty"` + + // NumMachineTranscribedExamples: The number of rows marked as + // MACHINE_TRANSCRIBED + NumMachineTranscribedExamples int64 `json:"numMachineTranscribedExamples,omitempty"` + + // TestExamplesCount: The number of examples labelled as TEST by Speech + // xps server. + TestExamplesCount int64 `json:"testExamplesCount,omitempty"` + + // TestSentencesCount: The number of sentences in the test data set. + TestSentencesCount int64 `json:"testSentencesCount,omitempty"` + + // TestWordsCount: The number of words in the test data set. + TestWordsCount int64 `json:"testWordsCount,omitempty"` + + // TrainExamplesCount: The number of examples labeled as TRAIN by Speech + // xps server. + TrainExamplesCount int64 `json:"trainExamplesCount,omitempty"` + + // TrainSentencesCount: The number of sentences in the training data + // set. + TrainSentencesCount int64 `json:"trainSentencesCount,omitempty"` + + // TrainWordsCount: The number of words in the training data set. + TrainWordsCount int64 `json:"trainWordsCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DataErrors") 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. "DataErrors") 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 *XPSSpeechPreprocessStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechPreprocessStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStringStats: The data statistics of a series of STRING values. +type XPSStringStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // TopUnigramStats: The statistics of the top 20 unigrams, ordered by + // StringStats.UnigramStats.count. + TopUnigramStats []*XPSStringStatsUnigramStats `json:"topUnigramStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSStringStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSStringStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStringStatsUnigramStats: The statistics of a unigram. +type XPSStringStatsUnigramStats struct { + // Count: The number of occurrences of this unigram in the series. + Count int64 `json:"count,omitempty,string"` + + // Value: The unigram. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSStringStatsUnigramStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSStringStatsUnigramStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStructStats: The data statistics of a series of STRUCT values. +type XPSStructStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // FieldStats: Map from a field name of the struct to data stats + // aggregated over series of all data in that field across all the + // structs. + FieldStats map[string]XPSDataStats `json:"fieldStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSStructStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSStructStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStructType: `StructType` defines the DataType-s of a STRUCT type. +type XPSStructType struct { + // Fields: Unordered map of struct field names to their data types. + Fields map[string]XPSDataType `json:"fields,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Fields") 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. "Fields") 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 *XPSStructType) MarshalJSON() ([]byte, error) { + type NoMethod XPSStructType + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTableSpec struct { + // ColumnSpecs: Mapping from column id to column spec. + ColumnSpecs map[string]XPSColumnSpec `json:"columnSpecs,omitempty"` + + // ImportedDataSizeInBytes: The total size of imported data of the + // table. + ImportedDataSizeInBytes int64 `json:"importedDataSizeInBytes,omitempty,string"` + + // RowCount: The number of rows in the table. + RowCount int64 `json:"rowCount,omitempty,string"` + + // TimeColumnId: The id of the time column. + TimeColumnId int64 `json:"timeColumnId,omitempty"` + + // ValidRowCount: The number of valid rows. + ValidRowCount int64 `json:"validRowCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ColumnSpecs") 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. "ColumnSpecs") 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 *XPSTableSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSTableSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesClassificationMetrics: Metrics for Tables classification +// problems. +type XPSTablesClassificationMetrics struct { + // CurveMetrics: Metrics building a curve. + CurveMetrics []*XPSTablesClassificationMetricsCurveMetrics `json:"curveMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CurveMetrics") 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. "CurveMetrics") 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 *XPSTablesClassificationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesClassificationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesClassificationMetricsCurveMetrics: Metrics curve data point +// for a single value. +type XPSTablesClassificationMetricsCurveMetrics struct { + // AucPr: The area under the precision-recall curve. + AucPr float64 `json:"aucPr,omitempty"` + + // AucRoc: The area under receiver operating characteristic curve. + AucRoc float64 `json:"aucRoc,omitempty"` + + // ConfidenceMetricsEntries: Metrics that have confidence thresholds. + // Precision-recall curve and ROC curve can be derived from them. + ConfidenceMetricsEntries []*XPSTablesConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // LogLoss: The Log loss metric. + LogLoss float64 `json:"logLoss,omitempty"` + + // PositionThreshold: The position threshold value used to compute the + // metrics. + PositionThreshold int64 `json:"positionThreshold,omitempty"` + + // Value: The CATEGORY row value (for ARRAY unnested) the curve metrics + // are for. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AucPr") 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. "AucPr") 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 *XPSTablesClassificationMetricsCurveMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesClassificationMetricsCurveMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesClassificationMetricsCurveMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesClassificationMetricsCurveMetrics + var s1 struct { + AucPr gensupport.JSONFloat64 `json:"aucPr"` + AucRoc gensupport.JSONFloat64 `json:"aucRoc"` + LogLoss gensupport.JSONFloat64 `json:"logLoss"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.AucPr = float64(s1.AucPr) + s.AucRoc = float64(s1.AucRoc) + s.LogLoss = float64(s1.LogLoss) + return nil +} + +// XPSTablesConfidenceMetricsEntry: Metrics for a single confidence +// threshold. +type XPSTablesConfidenceMetricsEntry struct { + // ConfidenceThreshold: The confidence threshold value used to compute + // the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: The harmonic mean of recall and precision. (2 * precision * + // recall) / (precision + recall) + F1Score float64 `json:"f1Score,omitempty"` + + // FalseNegativeCount: False negative count. + FalseNegativeCount int64 `json:"falseNegativeCount,omitempty,string"` + + // FalsePositiveCount: False positive count. + FalsePositiveCount int64 `json:"falsePositiveCount,omitempty,string"` + + // FalsePositiveRate: FPR = #false positives / (#false positives + #true + // negatives) + FalsePositiveRate float64 `json:"falsePositiveRate,omitempty"` + + // Precision: Precision = #true positives / (#true positives + #false + // positives). + Precision float64 `json:"precision,omitempty"` + + // Recall: Recall = #true positives / (#true positives + #false + // negatives). + Recall float64 `json:"recall,omitempty"` + + // TrueNegativeCount: True negative count. + TrueNegativeCount int64 `json:"trueNegativeCount,omitempty,string"` + + // TruePositiveCount: True positive count. + TruePositiveCount int64 `json:"truePositiveCount,omitempty,string"` + + // TruePositiveRate: TPR = #true positives / (#true positives + #false + // negatvies) + TruePositiveRate float64 `json:"truePositiveRate,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSTablesConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + FalsePositiveRate gensupport.JSONFloat64 `json:"falsePositiveRate"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + TruePositiveRate gensupport.JSONFloat64 `json:"truePositiveRate"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.FalsePositiveRate = float64(s1.FalsePositiveRate) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + s.TruePositiveRate = float64(s1.TruePositiveRate) + return nil +} + +// XPSTablesDatasetMetadata: Metadata for a dataset used for AutoML +// Tables. Next ID: 6 +type XPSTablesDatasetMetadata struct { + // MlUseColumnId: Id the column to split the table. + MlUseColumnId int64 `json:"mlUseColumnId,omitempty"` + + // PrimaryTableSpec: Primary table. + PrimaryTableSpec *XPSTableSpec `json:"primaryTableSpec,omitempty"` + + // TargetColumnCorrelations: (the column id : its CorrelationStats with + // target column). + TargetColumnCorrelations map[string]XPSCorrelationStats `json:"targetColumnCorrelations,omitempty"` + + // TargetColumnId: Id of the primary table column that should be used as + // the training label. + TargetColumnId int64 `json:"targetColumnId,omitempty"` + + // WeightColumnId: Id of the primary table column that should be used as + // the weight column. + WeightColumnId int64 `json:"weightColumnId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MlUseColumnId") 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. "MlUseColumnId") 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 *XPSTablesDatasetMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesDatasetMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTablesEvaluationMetrics struct { + // ClassificationMetrics: Classification metrics. + ClassificationMetrics *XPSTablesClassificationMetrics `json:"classificationMetrics,omitempty"` + + // RegressionMetrics: Regression metrics. + RegressionMetrics *XPSTablesRegressionMetrics `json:"regressionMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ClassificationMetrics") 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. "ClassificationMetrics") 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 *XPSTablesEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesModelColumnInfo: An information specific to given column and +// Tables Model, in context of the Model and the predictions created by +// it. +type XPSTablesModelColumnInfo struct { + // ColumnId: The ID of the column. + ColumnId int64 `json:"columnId,omitempty"` + + // FeatureImportance: When given as part of a Model: Measurement of how + // much model predictions correctness on the TEST data depend on values + // in this column. A value between 0 and 1, higher means higher + // influence. These values are normalized - for all input feature + // columns of a given model they add to 1. When given back by Predict or + // Batch Predict: Measurement of how impactful for the prediction + // returned for the given row the value in this column was. + // Specifically, the feature importance specifies the marginal + // contribution that the feature made to the prediction score compared + // to the baseline score. These values are computed using the Sampled + // Shapley method. + FeatureImportance float64 `json:"featureImportance,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnId") 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. "ColumnId") 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 *XPSTablesModelColumnInfo) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelColumnInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesModelColumnInfo) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesModelColumnInfo + var s1 struct { + FeatureImportance gensupport.JSONFloat64 `json:"featureImportance"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.FeatureImportance = float64(s1.FeatureImportance) + return nil +} + +// XPSTablesModelStructure: A description of Tables model structure. +type XPSTablesModelStructure struct { + // ModelParameters: A list of models. + ModelParameters []*XPSTablesModelStructureModelParameters `json:"modelParameters,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ModelParameters") 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. "ModelParameters") 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 *XPSTablesModelStructure) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelStructure + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesModelStructureModelParameters: Model hyper-parameters for a +// model. +type XPSTablesModelStructureModelParameters struct { + Hyperparameters []*XPSTablesModelStructureModelParametersParameter `json:"hyperparameters,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Hyperparameters") 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. "Hyperparameters") 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 *XPSTablesModelStructureModelParameters) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelStructureModelParameters + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTablesModelStructureModelParametersParameter struct { + // FloatValue: Float type parameter value. + FloatValue float64 `json:"floatValue,omitempty"` + + // IntValue: Integer type parameter value. + IntValue int64 `json:"intValue,omitempty,string"` + + // Name: Parameter name. + Name string `json:"name,omitempty"` + + // StringValue: String type parameter value. + StringValue string `json:"stringValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FloatValue") 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. "FloatValue") 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 *XPSTablesModelStructureModelParametersParameter) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelStructureModelParametersParameter + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesModelStructureModelParametersParameter) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesModelStructureModelParametersParameter + var s1 struct { + FloatValue gensupport.JSONFloat64 `json:"floatValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.FloatValue = float64(s1.FloatValue) + return nil +} + +type XPSTablesPreprocessResponse struct { + // TablesDatasetMetadata: The table/column id, column_name and the + // DataTypes of the columns will be populated. + TablesDatasetMetadata *XPSTablesDatasetMetadata `json:"tablesDatasetMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "TablesDatasetMetadata") 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. "TablesDatasetMetadata") 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 *XPSTablesPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesRegressionMetrics: Metrics for Tables regression problems. +type XPSTablesRegressionMetrics struct { + // MeanAbsoluteError: Mean absolute error. + MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` + + // MeanAbsolutePercentageError: Mean absolute percentage error, only set + // if all of the target column's values are positive. + MeanAbsolutePercentageError float64 `json:"meanAbsolutePercentageError,omitempty"` + + // RSquared: R squared. + RSquared float64 `json:"rSquared,omitempty"` + + // RegressionMetricsEntries: A list of actual versus predicted points + // for the model being evaluated. + RegressionMetricsEntries []*XPSRegressionMetricsEntry `json:"regressionMetricsEntries,omitempty"` + + // RootMeanSquaredError: Root mean squared error. + RootMeanSquaredError float64 `json:"rootMeanSquaredError,omitempty"` + + // RootMeanSquaredLogError: Root mean squared log error. + RootMeanSquaredLogError float64 `json:"rootMeanSquaredLogError,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MeanAbsoluteError") + // 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. "MeanAbsoluteError") 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 *XPSTablesRegressionMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesRegressionMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesRegressionMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesRegressionMetrics + var s1 struct { + MeanAbsoluteError gensupport.JSONFloat64 `json:"meanAbsoluteError"` + MeanAbsolutePercentageError gensupport.JSONFloat64 `json:"meanAbsolutePercentageError"` + RSquared gensupport.JSONFloat64 `json:"rSquared"` + RootMeanSquaredError gensupport.JSONFloat64 `json:"rootMeanSquaredError"` + RootMeanSquaredLogError gensupport.JSONFloat64 `json:"rootMeanSquaredLogError"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.MeanAbsoluteError = float64(s1.MeanAbsoluteError) + s.MeanAbsolutePercentageError = float64(s1.MeanAbsolutePercentageError) + s.RSquared = float64(s1.RSquared) + s.RootMeanSquaredError = float64(s1.RootMeanSquaredError) + s.RootMeanSquaredLogError = float64(s1.RootMeanSquaredLogError) + return nil +} + +type XPSTablesTrainResponse struct { + ModelStructure *XPSTablesModelStructure `json:"modelStructure,omitempty"` + + // PredictionSampleRows: Sample rows from the dataset this model was + // trained. + PredictionSampleRows []*XPSRow `json:"predictionSampleRows,omitempty"` + + // TablesModelColumnInfo: Output only. Auxiliary information for each of + // the input_feature_column_specs, with respect to this particular + // model. + TablesModelColumnInfo []*XPSTablesModelColumnInfo `json:"tablesModelColumnInfo,omitempty"` + + // TrainCostMilliNodeHours: The actual training cost of the model, + // expressed in milli node hours, i.e. 1,000 value in this field means 1 + // node hour. Guaranteed to not exceed the train budget. + TrainCostMilliNodeHours int64 `json:"trainCostMilliNodeHours,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ModelStructure") 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. "ModelStructure") 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 *XPSTablesTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTablesTrainingOperationMetadata struct { + // CreateModelStage: Current stage of creating model. + // + // Possible values: + // "CREATE_MODEL_STAGE_UNSPECIFIED" - Unspecified stage. + // "DATA_PREPROCESSING" - Prepare the model training pipeline and run + // data processing. + // "TRAINING" - Training model. + // "EVALUATING" - Run evaluation. + // "MODEL_POST_PROCESSING" - Finalizing model training pipeline. + CreateModelStage string `json:"createModelStage,omitempty"` + + // OptimizationObjective: The optimization objective for model. + OptimizationObjective string `json:"optimizationObjective,omitempty"` + + // TopTrials: This field is for training. When the operation is + // terminated successfully, AutoML Backend post this field to operation + // metadata in spanner. If the metadata has no trials returned, the + // training operation is supposed to be a failure. + TopTrials []*XPSTuningTrial `json:"topTrials,omitempty"` + + // TrainBudgetMilliNodeHours: Creating model budget. + TrainBudgetMilliNodeHours int64 `json:"trainBudgetMilliNodeHours,omitempty,string"` + + // TrainingObjectivePoints: This field records the training objective + // value with respect to time, giving insight into how the model + // architecture search is performing as training time elapses. + TrainingObjectivePoints []*XPSTrainingObjectivePoint `json:"trainingObjectivePoints,omitempty"` + + // TrainingStartTime: Timestamp when training process starts. + TrainingStartTime string `json:"trainingStartTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateModelStage") 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. "CreateModelStage") 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 *XPSTablesTrainingOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesTrainingOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTextComponentModel: Component model. Next ID: 10 +type XPSTextComponentModel struct { + // BatchPredictionModelGcsUri: The Cloud Storage resource path to hold + // batch prediction model. + BatchPredictionModelGcsUri string `json:"batchPredictionModelGcsUri,omitempty"` + + // OnlinePredictionModelGcsUri: The Cloud Storage resource path to hold + // online prediction model. + OnlinePredictionModelGcsUri string `json:"onlinePredictionModelGcsUri,omitempty"` + + // Partition: The partition where the model is deployed. Populated by + // uCAIP BE as part of online PredictRequest. + // + // Possible values: + // "PARTITION_TYPE_UNSPECIFIED" + // "PARTITION_ZERO" - The default partition. + // "PARTITION_REDUCED_HOMING" - It has significantly lower replication + // than partition-0 and is located in the US only. It also has a larger + // model size limit and higher default RAM quota than partition-0. + // Customers with batch traffic, US-based traffic, or very large models + // should use this partition. Capacity in this partition is + // significantly cheaper than partition-0. + // "PARTITION_JELLYFISH" - To be used by customers with + // Jellyfish-accelerated ops. See go/servomatic-jellyfish for details. + // "PARTITION_CPU" - The partition used by regionalized servomatic + // cloud regions. + // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading + // models from custom storage. + Partition string `json:"partition,omitempty"` + + // ServingArtifact: The default model binary file used for serving (e.g. + // online predict, batch predict) via public Cloud Ai Platform API. + ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` + + // ServoModelName: The name of servo model. Populated by uCAIP BE as + // part of online PredictRequest. + ServoModelName string `json:"servoModelName,omitempty"` + + // SubmodelName: The name of the trained NL submodel. + SubmodelName string `json:"submodelName,omitempty"` + + // SubmodelType: The type of trained NL submodel + // + // Possible values: + // "TEXT_MODEL_TYPE_UNSPECIFIED" + // "TEXT_MODEL_TYPE_DEFAULT" + // "TEXT_MODEL_TYPE_META_ARCHITECT" + // "TEXT_MODEL_TYPE_ATC" + // "TEXT_MODEL_TYPE_CLARA2" + // "TEXT_MODEL_TYPE_CHATBASE" + // "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING" + // "TEXT_MODEL_TYPE_TEXT_EXTRACTION" - Model type for entity + // extraction. + // "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION" - Model type for + // relationship extraction. + // "TEXT_MODEL_TYPE_COMPOSITE" - A composite model represents a set of + // component models that have to be used together for prediction. A + // composite model appears to be a single model to the model user. It + // may contain only one component model. Please refer to + // go/cnl-composite-models for more information. + // "TEXT_MODEL_TYPE_ALL_MODELS" - Model type used to train default, + // MA, and ATC models in a single batch worker pipeline. + // "TEXT_MODEL_TYPE_BERT" - BERT pipeline needs a specific model type, + // since it uses a different TFX configuration compared with DEFAULT + // (despite sharing most of the code). + // "TEXT_MODEL_TYPE_ENC_PALM" - Model type for EncPaLM. + SubmodelType string `json:"submodelType,omitempty"` + + // TfRuntimeVersion: ## The fields below are only populated under uCAIP + // request scope. + // https://cloud.google.com/ml-engine/docs/runtime-version-list + TfRuntimeVersion string `json:"tfRuntimeVersion,omitempty"` + + // VersionNumber: The servomatic model version number. Populated by + // uCAIP BE as part of online PredictRequest. + VersionNumber int64 `json:"versionNumber,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. + // "BatchPredictionModelGcsUri") 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. + // "BatchPredictionModelGcsUri") 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 *XPSTextComponentModel) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextComponentModel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTextExtractionEvaluationMetrics struct { + // BestF1ConfidenceMetrics: Values are at the highest F1 score on the + // precision-recall curve. Only confidence_threshold, recall, precision, + // and f1_score will be set. + BestF1ConfidenceMetrics *XPSConfidenceMetricsEntry `json:"bestF1ConfidenceMetrics,omitempty"` + + // ConfidenceMetricsEntries: If the enclosing EvaluationMetrics.label is + // empty, confidence_metrics_entries is an evaluation of the entire + // model across all labels. If the enclosing EvaluationMetrics.label is + // set, confidence_metrics_entries applies to that label. + ConfidenceMetricsEntries []*XPSConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // ConfusionMatrix: Confusion matrix of the model, at the default + // confidence threshold (0.0). Only set for whole-model evaluation, not + // for evaluation per label. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // PerLabelConfidenceMetrics: Only recall, precision, and f1_score will + // be set. + PerLabelConfidenceMetrics map[string]XPSConfidenceMetricsEntry `json:"perLabelConfidenceMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BestF1ConfidenceMetrics") 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. "BestF1ConfidenceMetrics") + // 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 *XPSTextExtractionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextExtractionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTextSentimentEvaluationMetrics: Model evaluation metrics for text +// sentiment problems. +type XPSTextSentimentEvaluationMetrics struct { + // ConfusionMatrix: Output only. Confusion matrix of the evaluation. + // Only set for the overall model evaluation, not for evaluation of a + // single annotation spec. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // F1Score: Output only. The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // LinearKappa: Output only. Linear weighted kappa. Only set for the + // overall model evaluation, not for evaluation of a single annotation + // spec. + LinearKappa float64 `json:"linearKappa,omitempty"` + + // MeanAbsoluteError: Output only. Mean absolute error. Only set for the + // overall model evaluation, not for evaluation of a single annotation + // spec. + MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` + + // MeanSquaredError: Output only. Mean squared error. Only set for the + // overall model evaluation, not for evaluation of a single annotation + // spec. + MeanSquaredError float64 `json:"meanSquaredError,omitempty"` + + // Precision: Output only. Precision. + Precision float64 `json:"precision,omitempty"` + + // QuadraticKappa: Output only. Quadratic weighted kappa. Only set for + // the overall model evaluation, not for evaluation of a single + // annotation spec. + QuadraticKappa float64 `json:"quadraticKappa,omitempty"` + + // Recall: Output only. Recall. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfusionMatrix") 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. "ConfusionMatrix") 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 *XPSTextSentimentEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextSentimentEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTextSentimentEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTextSentimentEvaluationMetrics + var s1 struct { + F1Score gensupport.JSONFloat64 `json:"f1Score"` + LinearKappa gensupport.JSONFloat64 `json:"linearKappa"` + MeanAbsoluteError gensupport.JSONFloat64 `json:"meanAbsoluteError"` + MeanSquaredError gensupport.JSONFloat64 `json:"meanSquaredError"` + Precision gensupport.JSONFloat64 `json:"precision"` + QuadraticKappa gensupport.JSONFloat64 `json:"quadraticKappa"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.F1Score = float64(s1.F1Score) + s.LinearKappa = float64(s1.LinearKappa) + s.MeanAbsoluteError = float64(s1.MeanAbsoluteError) + s.MeanSquaredError = float64(s1.MeanSquaredError) + s.Precision = float64(s1.Precision) + s.QuadraticKappa = float64(s1.QuadraticKappa) + s.Recall = float64(s1.Recall) + return nil +} + +// XPSTextToSpeechTrainResponse: TextToSpeech train response +type XPSTextToSpeechTrainResponse struct { +} + +type XPSTextTrainResponse struct { + // ComponentModel: Component submodels. + ComponentModel []*XPSTextComponentModel `json:"componentModel,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ComponentModel") 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. "ComponentModel") 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 *XPSTextTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTfJsFormat: A TensorFlow.js (https://www.tensorflow.org/js) model +// that can be used in the browser and in Node.js using JavaScript. +type XPSTfJsFormat struct { +} + +// XPSTfLiteFormat: LINT.IfChange A model format used for mobile and IoT +// devices. See https://www.tensorflow.org/lite. +type XPSTfLiteFormat struct { +} + +// XPSTfSavedModelFormat: A tensorflow model format in SavedModel +// format. +type XPSTfSavedModelFormat struct { +} + +// XPSTimestampStats: The data statistics of a series of TIMESTAMP +// values. +type XPSTimestampStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // GranularStats: The string key is the pre-defined granularity. + // Currently supported: hour_of_day, day_of_week, month_of_year. + // Granularities finer that the granularity of timestamp data are not + // populated (e.g. if timestamps are at day granularity, then + // hour_of_day is not populated). + GranularStats map[string]XPSTimestampStatsGranularStats `json:"granularStats,omitempty"` + + MedianTimestampNanos int64 `json:"medianTimestampNanos,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSTimestampStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSTimestampStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTimestampStatsGranularStats: Stats split by a defined in context +// granularity. +type XPSTimestampStatsGranularStats struct { + // Buckets: A map from granularity key to example count for that key. + // E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means + // May). + Buckets map[string]string `json:"buckets,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Buckets") 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. "Buckets") 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 *XPSTimestampStatsGranularStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSTimestampStatsGranularStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTrackMetricsEntry: Track matching model metrics for a single track +// match threshold and multiple label match confidence thresholds. Next +// tag: 6. +type XPSTrackMetricsEntry struct { + // ConfidenceMetricsEntries: Output only. Metrics for each label-match + // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + // Precision-recall curve is derived from them. + ConfidenceMetricsEntries []*XPSTrackMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // IouThreshold: Output only. The intersection-over-union threshold + // value between bounding boxes across frames used to compute this + // metric entry. + IouThreshold float64 `json:"iouThreshold,omitempty"` + + // MeanBoundingBoxIou: Output only. The mean bounding box iou over all + // confidence thresholds. + MeanBoundingBoxIou float64 `json:"meanBoundingBoxIou,omitempty"` + + // MeanMismatchRate: Output only. The mean mismatch rate over all + // confidence thresholds. + MeanMismatchRate float64 `json:"meanMismatchRate,omitempty"` + + // MeanTrackingAveragePrecision: Output only. The mean average precision + // over all confidence thresholds. + MeanTrackingAveragePrecision float64 `json:"meanTrackingAveragePrecision,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSTrackMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrackMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTrackMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSTrackMetricsEntry + var s1 struct { + IouThreshold gensupport.JSONFloat64 `json:"iouThreshold"` + MeanBoundingBoxIou gensupport.JSONFloat64 `json:"meanBoundingBoxIou"` + MeanMismatchRate gensupport.JSONFloat64 `json:"meanMismatchRate"` + MeanTrackingAveragePrecision gensupport.JSONFloat64 `json:"meanTrackingAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.IouThreshold = float64(s1.IouThreshold) + s.MeanBoundingBoxIou = float64(s1.MeanBoundingBoxIou) + s.MeanMismatchRate = float64(s1.MeanMismatchRate) + s.MeanTrackingAveragePrecision = float64(s1.MeanTrackingAveragePrecision) + return nil +} + +// XPSTrackMetricsEntryConfidenceMetricsEntry: Metrics for a single +// confidence threshold. Next tag: 6. +type XPSTrackMetricsEntryConfidenceMetricsEntry struct { + // BoundingBoxIou: Output only. Bounding box intersection-over-union + // precision. Measures how well the bounding boxes overlap between each + // other (e.g. complete overlap or just barely above iou_threshold). + BoundingBoxIou float64 `json:"boundingBoxIou,omitempty"` + + // ConfidenceThreshold: Output only. The confidence threshold value used + // to compute the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // MismatchRate: Output only. Mismatch rate, which measures the tracking + // consistency, i.e. correctness of instance ID continuity. + MismatchRate float64 `json:"mismatchRate,omitempty"` + + // TrackingPrecision: Output only. Tracking precision. + TrackingPrecision float64 `json:"trackingPrecision,omitempty"` + + // TrackingRecall: Output only. Tracking recall. + TrackingRecall float64 `json:"trackingRecall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BoundingBoxIou") 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. "BoundingBoxIou") 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 *XPSTrackMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrackMetricsEntryConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSTrackMetricsEntryConfidenceMetricsEntry + var s1 struct { + BoundingBoxIou gensupport.JSONFloat64 `json:"boundingBoxIou"` + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + MismatchRate gensupport.JSONFloat64 `json:"mismatchRate"` + TrackingPrecision gensupport.JSONFloat64 `json:"trackingPrecision"` + TrackingRecall gensupport.JSONFloat64 `json:"trackingRecall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BoundingBoxIou = float64(s1.BoundingBoxIou) + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.MismatchRate = float64(s1.MismatchRate) + s.TrackingPrecision = float64(s1.TrackingPrecision) + s.TrackingRecall = float64(s1.TrackingRecall) + return nil +} + +// XPSTrainResponse: Next ID: 18 +type XPSTrainResponse struct { + // DeployedModelSizeBytes: Estimated model size in bytes once deployed. + DeployedModelSizeBytes int64 `json:"deployedModelSizeBytes,omitempty,string"` + + // ErrorAnalysisConfigs: Optional vision model error analysis + // configuration. The field is set when model error analysis is enabled + // in the training request. The results of error analysis will be binded + // together with evaluation results (in the format of AnnotatedExample). + ErrorAnalysisConfigs []*XPSVisionErrorAnalysisConfig `json:"errorAnalysisConfigs,omitempty"` + + // EvaluatedExampleSet: Examples used to evaluate the model (usually the + // test set), with the predicted annotations. The file_spec should point + // to recordio file(s) of AnnotatedExample. For each returned example, + // the example_id_token and annotations predicted by the model must be + // set. The example payload can and is recommended to be omitted. + EvaluatedExampleSet *XPSExampleSet `json:"evaluatedExampleSet,omitempty"` + + // EvaluationMetricsSet: The trained model evaluation metrics. This can + // be optionally returned. + EvaluationMetricsSet *XPSEvaluationMetricsSet `json:"evaluationMetricsSet,omitempty"` + + // ExplanationConfigs: VisionExplanationConfig for XAI on test set. + // Optional for when XAI is enable in training request. + ExplanationConfigs []*XPSResponseExplanationSpec `json:"explanationConfigs,omitempty"` + + ImageClassificationTrainResp *XPSImageClassificationTrainResponse `json:"imageClassificationTrainResp,omitempty"` + + ImageObjectDetectionTrainResp *XPSImageObjectDetectionModelSpec `json:"imageObjectDetectionTrainResp,omitempty"` + + ImageSegmentationTrainResp *XPSImageSegmentationTrainResponse `json:"imageSegmentationTrainResp,omitempty"` + + // ModelToken: Token that represents the trained model. This is + // considered immutable and is persisted in AutoML. xPS can put their + // own proto in the byte string, to e.g. point to the model checkpoints. + // The token is passed to other xPS APIs to refer to the model. + ModelToken string `json:"modelToken,omitempty"` + + SpeechTrainResp *XPSSpeechModelSpec `json:"speechTrainResp,omitempty"` + + TablesTrainResp *XPSTablesTrainResponse `json:"tablesTrainResp,omitempty"` + + TextToSpeechTrainResp *XPSTextToSpeechTrainResponse `json:"textToSpeechTrainResp,omitempty"` + + // TextTrainResp: Will only be needed for uCAIP from Beta. + TextTrainResp *XPSTextTrainResponse `json:"textTrainResp,omitempty"` + + TranslationTrainResp *XPSTranslationTrainResponse `json:"translationTrainResp,omitempty"` + + VideoActionRecognitionTrainResp *XPSVideoActionRecognitionTrainResponse `json:"videoActionRecognitionTrainResp,omitempty"` + + VideoClassificationTrainResp *XPSVideoClassificationTrainResponse `json:"videoClassificationTrainResp,omitempty"` + + VideoObjectTrackingTrainResp *XPSVideoObjectTrackingTrainResponse `json:"videoObjectTrackingTrainResp,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DeployedModelSizeBytes") 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. "DeployedModelSizeBytes") + // 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 *XPSTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTrainingObjectivePoint struct { + // CreateTime: The time at which this point was recorded. + CreateTime string `json:"createTime,omitempty"` + + // Value: The objective value when this point was recorded. + Value float64 `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *XPSTrainingObjectivePoint) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrainingObjectivePoint + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTrainingObjectivePoint) UnmarshalJSON(data []byte) error { + type NoMethod XPSTrainingObjectivePoint + 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 +} + +// XPSTranslationEvaluationMetrics: Evaluation metrics for the dataset. +type XPSTranslationEvaluationMetrics struct { + // BaseBleuScore: BLEU score for base model. + BaseBleuScore float64 `json:"baseBleuScore,omitempty"` + + // BleuScore: BLEU score. + BleuScore float64 `json:"bleuScore,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BaseBleuScore") 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. "BaseBleuScore") 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 *XPSTranslationEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTranslationEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTranslationEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTranslationEvaluationMetrics + var s1 struct { + BaseBleuScore gensupport.JSONFloat64 `json:"baseBleuScore"` + BleuScore gensupport.JSONFloat64 `json:"bleuScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BaseBleuScore = float64(s1.BaseBleuScore) + s.BleuScore = float64(s1.BleuScore) + return nil +} + +// XPSTranslationPreprocessResponse: Translation preprocess response. +type XPSTranslationPreprocessResponse struct { + // ParsedExampleCount: Total example count parsed. + ParsedExampleCount int64 `json:"parsedExampleCount,omitempty,string"` + + // ValidExampleCount: Total valid example count. + ValidExampleCount int64 `json:"validExampleCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ParsedExampleCount") + // 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. "ParsedExampleCount") 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 *XPSTranslationPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTranslationPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTranslationTrainResponse: Train response for translation. +type XPSTranslationTrainResponse struct { + // ModelType: Type of the model. + // + // Possible values: + // "MODEL_TYPE_UNSPECIFIED" - Default + // "LEGACY" - Legacy model. Will be deprecated. + // "CURRENT" - Current model. + ModelType string `json:"modelType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ModelType") 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. "ModelType") 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 *XPSTranslationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTranslationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTuningTrial: Metrics for a tuning job generated, will get +// forwarded to Stackdriver as model tuning logs. Setting this as a +// standalone message out of CreateModelMetadata to avoid confusion as +// we expose this message only to users. +type XPSTuningTrial struct { + // ModelStructure: Model parameters for the trial. + ModelStructure *XPSTablesModelStructure `json:"modelStructure,omitempty"` + + // TrainingObjectivePoint: The optimization objective evaluation of the + // eval split data. + TrainingObjectivePoint *XPSTrainingObjectivePoint `json:"trainingObjectivePoint,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ModelStructure") 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. "ModelStructure") 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 *XPSTuningTrial) MarshalJSON() ([]byte, error) { + type NoMethod XPSTuningTrial + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVideoActionMetricsEntry: The Evaluation metrics entry given a +// specific precision_window_length. +type XPSVideoActionMetricsEntry struct { + // ConfidenceMetricsEntries: Metrics for each label-match + // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + ConfidenceMetricsEntries []*XPSVideoActionMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // MeanAveragePrecision: The mean average precision. + MeanAveragePrecision float64 `json:"meanAveragePrecision,omitempty"` + + // PrecisionWindowLength: This VideoActionMetricsEntry is calculated + // based on this prediction window length. If the predicted action's + // timestamp is inside the time window whose center is the ground truth + // action's timestamp with this specific length, the prediction result + // is treated as a true positive. + PrecisionWindowLength string `json:"precisionWindowLength,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSVideoActionMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVideoActionMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSVideoActionMetricsEntry + var s1 struct { + MeanAveragePrecision gensupport.JSONFloat64 `json:"meanAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.MeanAveragePrecision = float64(s1.MeanAveragePrecision) + return nil +} + +// XPSVideoActionMetricsEntryConfidenceMetricsEntry: Metrics for a +// single confidence threshold. +type XPSVideoActionMetricsEntryConfidenceMetricsEntry struct { + // ConfidenceThreshold: Output only. The confidence threshold value used + // to compute the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: Output only. The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // Precision: Output only. Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // Recall: Output only. Recall for the given confidence threshold. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSVideoActionMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionMetricsEntryConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVideoActionMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSVideoActionMetricsEntryConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + return nil +} + +// XPSVideoActionRecognitionEvaluationMetrics: Model evaluation metrics +// for video action recognition. +type XPSVideoActionRecognitionEvaluationMetrics struct { + // EvaluatedActionCount: Output only. The number of ground truth actions + // used to create this evaluation. + EvaluatedActionCount int64 `json:"evaluatedActionCount,omitempty"` + + // VideoActionMetricsEntries: Output only. The metric entries for + // precision window lengths: 1s,2s,3s,4s, 5s. + VideoActionMetricsEntries []*XPSVideoActionMetricsEntry `json:"videoActionMetricsEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EvaluatedActionCount") 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. "EvaluatedActionCount") 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 *XPSVideoActionRecognitionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionRecognitionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoActionRecognitionTrainResponse struct { + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ModelArtifactSpec") + // 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. "ModelArtifactSpec") 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 *XPSVideoActionRecognitionTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionRecognitionTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoBatchPredictOperationMetadata struct { + // OutputExamples: All the partial batch prediction results that are + // completed at the moment. Output examples are sorted by completion + // time. The order will not be changed. Each output example should be + // the path of a single RecordIO file of AnnotatedExamples. + OutputExamples []string `json:"outputExamples,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OutputExamples") 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. "OutputExamples") 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 *XPSVideoBatchPredictOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoBatchPredictOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoClassificationTrainResponse struct { + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ModelArtifactSpec") + // 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. "ModelArtifactSpec") 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 *XPSVideoClassificationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoClassificationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVideoExportModelSpec: Information of downloadable models that are +// pre-generated as part of training flow and will be persisted in +// AutoMl backend. Upon receiving ExportModel request from user, AutoMl +// backend can serve the pre-generated models to user if exists (by +// copying the files from internal path to user provided location), +// otherwise, AutoMl backend will call xPS ExportModel API to generate +// the model on the fly with the requesting format. +type XPSVideoExportModelSpec struct { + // ExportModelOutputConfig: Contains the model format and internal + // location of the model files to be exported/downloaded. Use the GCS + // bucket name which is provided via TrainRequest.gcs_bucket_name to + // store the model files. + ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ExportModelOutputConfig") 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. "ExportModelOutputConfig") + // 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 *XPSVideoExportModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoExportModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoModelArtifactSpec struct { + // ExportArtifact: The model binary files in different formats for model + // export. + ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` + + // ServingArtifact: The default model binary file used for serving (e.g. + // batch predict) via public Cloud AI Platform API. + ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExportArtifact") 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. "ExportArtifact") 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 *XPSVideoModelArtifactSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoModelArtifactSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVideoObjectTrackingEvaluationMetrics: Model evaluation metrics for +// ObjectTracking problems. Next tag: 10. +type XPSVideoObjectTrackingEvaluationMetrics struct { + // BoundingBoxMeanAveragePrecision: Output only. The single metric for + // bounding boxes evaluation: the mean_average_precision averaged over + // all bounding_box_metrics_entries. + BoundingBoxMeanAveragePrecision float64 `json:"boundingBoxMeanAveragePrecision,omitempty"` + + // BoundingBoxMetricsEntries: Output only. The bounding boxes match + // metrics for each Intersection-over-union threshold + // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + BoundingBoxMetricsEntries []*XPSBoundingBoxMetricsEntry `json:"boundingBoxMetricsEntries,omitempty"` + + // EvaluatedBoundingboxCount: The number of bounding boxes used for + // model evaluation. + EvaluatedBoundingboxCount int64 `json:"evaluatedBoundingboxCount,omitempty"` + + // EvaluatedFrameCount: The number of video frames used for model + // evaluation. + EvaluatedFrameCount int64 `json:"evaluatedFrameCount,omitempty"` + + // EvaluatedTrackCount: The number of tracks used for model evaluation. + EvaluatedTrackCount int64 `json:"evaluatedTrackCount,omitempty"` + + // TrackMeanAveragePrecision: Output only. The single metric for tracks + // accuracy evaluation: the mean_average_precision averaged over all + // track_metrics_entries. + TrackMeanAveragePrecision float64 `json:"trackMeanAveragePrecision,omitempty"` + + // TrackMeanBoundingBoxIou: Output only. The single metric for tracks + // bounding box iou evaluation: the mean_bounding_box_iou averaged over + // all track_metrics_entries. + TrackMeanBoundingBoxIou float64 `json:"trackMeanBoundingBoxIou,omitempty"` + + // TrackMeanMismatchRate: Output only. The single metric for tracking + // consistency evaluation: the mean_mismatch_rate averaged over all + // track_metrics_entries. + TrackMeanMismatchRate float64 `json:"trackMeanMismatchRate,omitempty"` + + // TrackMetricsEntries: Output only. The tracks match metrics for each + // Intersection-over-union threshold + // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + TrackMetricsEntries []*XPSTrackMetricsEntry `json:"trackMetricsEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BoundingBoxMeanAveragePrecision") 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. + // "BoundingBoxMeanAveragePrecision") 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 *XPSVideoObjectTrackingEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoObjectTrackingEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVideoObjectTrackingEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSVideoObjectTrackingEvaluationMetrics + var s1 struct { + BoundingBoxMeanAveragePrecision gensupport.JSONFloat64 `json:"boundingBoxMeanAveragePrecision"` + TrackMeanAveragePrecision gensupport.JSONFloat64 `json:"trackMeanAveragePrecision"` + TrackMeanBoundingBoxIou gensupport.JSONFloat64 `json:"trackMeanBoundingBoxIou"` + TrackMeanMismatchRate gensupport.JSONFloat64 `json:"trackMeanMismatchRate"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BoundingBoxMeanAveragePrecision = float64(s1.BoundingBoxMeanAveragePrecision) + s.TrackMeanAveragePrecision = float64(s1.TrackMeanAveragePrecision) + s.TrackMeanBoundingBoxIou = float64(s1.TrackMeanBoundingBoxIou) + s.TrackMeanMismatchRate = float64(s1.TrackMeanMismatchRate) + return nil +} + +type XPSVideoObjectTrackingTrainResponse struct { + // ExportModelSpec: Populated for AutoML request only. + ExportModelSpec *XPSVideoExportModelSpec `json:"exportModelSpec,omitempty"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ExportModelSpec") 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. "ExportModelSpec") 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 *XPSVideoObjectTrackingTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoObjectTrackingTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoTrainingOperationMetadata struct { + // TrainCostMilliNodeHour: This is an estimation of the node hours + // necessary for training a model, expressed in milli node hours (i.e. + // 1,000 value in this field means 1 node hour). A node hour represents + // the time a virtual machine spends running your training job. The cost + // of one node running for one hour is a node hour. + TrainCostMilliNodeHour int64 `json:"trainCostMilliNodeHour,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. + // "TrainCostMilliNodeHour") 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. "TrainCostMilliNodeHour") + // 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 *XPSVideoTrainingOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoTrainingOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVisionErrorAnalysisConfig: The vision model error analysis +// configuration. Next tag: 3 +type XPSVisionErrorAnalysisConfig struct { + // ExampleCount: The number of query examples in error analysis. + ExampleCount int64 `json:"exampleCount,omitempty"` + + // QueryType: The query type used in retrieval. The enum values are + // frozen in the foreseeable future. + // + // Possible values: + // "QUERY_TYPE_UNSPECIFIED" - Unspecified query type for model error + // analysis. + // "QUERY_TYPE_ALL_SIMILAR" - Query similar samples across all classes + // in the dataset. + // "QUERY_TYPE_SAME_CLASS_SIMILAR" - Query similar samples from the + // same class of the input sample. + // "QUERY_TYPE_SAME_CLASS_DISSIMILAR" - Query dissimilar samples from + // the same class of the input sample. + QueryType string `json:"queryType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExampleCount") 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. "ExampleCount") 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 *XPSVisionErrorAnalysisConfig) MarshalJSON() ([]byte, error) { + type NoMethod XPSVisionErrorAnalysisConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVisionTrainingOperationMetadata struct { + // ExplanationUsage: Aggregated infra usage within certain time period, + // for billing report purpose if XAI is enable in training request. + ExplanationUsage *InfraUsage `json:"explanationUsage,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExplanationUsage") 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. "ExplanationUsage") 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 *XPSVisionTrainingOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSVisionTrainingOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVisualization: Visualization configurations for image explanation. +type XPSVisualization struct { + // ClipPercentLowerbound: Excludes attributions below the specified + // percentile, from the highlighted areas. Defaults to 62. + ClipPercentLowerbound float64 `json:"clipPercentLowerbound,omitempty"` + + // ClipPercentUpperbound: Excludes attributions above the specified + // percentile from the highlighted areas. Using the + // clip_percent_upperbound and clip_percent_lowerbound together can be + // useful for filtering out noise and making it easier to see areas of + // strong attribution. Defaults to 99.9. + ClipPercentUpperbound float64 `json:"clipPercentUpperbound,omitempty"` + + // ColorMap: The color scheme used for the highlighted areas. Defaults + // to PINK_GREEN for Integrated Gradients attribution, which shows + // positive attributions in green and negative in pink. Defaults to + // VIRIDIS for XRAI attribution, which highlights the most influential + // regions in yellow and the least influential in blue. + // + // Possible values: + // "COLOR_MAP_UNSPECIFIED" - Should not be used. + // "PINK_GREEN" - Positive: green. Negative: pink. + // "VIRIDIS" - Viridis color map: A perceptually uniform color mapping + // which is easier to see by those with colorblindness and progresses + // from yellow to green to blue. Positive: yellow. Negative: blue. + // "RED" - Positive: red. Negative: red. + // "GREEN" - Positive: green. Negative: green. + // "RED_GREEN" - Positive: green. Negative: red. + // "PINK_WHITE_GREEN" - PiYG palette. + ColorMap string `json:"colorMap,omitempty"` + + // OverlayType: How the original image is displayed in the + // visualization. Adjusting the overlay can help increase visual clarity + // if the original image makes it difficult to view the visualization. + // Defaults to NONE. + // + // Possible values: + // "OVERLAY_TYPE_UNSPECIFIED" - Default value. This is the same as + // NONE. + // "NONE" - No overlay. + // "ORIGINAL" - The attributions are shown on top of the original + // image. + // "GRAYSCALE" - The attributions are shown on top of grayscaled + // version of the original image. + // "MASK_BLACK" - The attributions are used as a mask to reveal + // predictive parts of the image and hide the un-predictive parts. + OverlayType string `json:"overlayType,omitempty"` + + // Polarity: Whether to only highlight pixels with positive + // contributions, negative or both. Defaults to POSITIVE. + // + // Possible values: + // "POLARITY_UNSPECIFIED" - Default value. This is the same as + // POSITIVE. + // "POSITIVE" - Highlights the pixels/outlines that were most + // influential to the model's prediction. + // "NEGATIVE" - Setting polarity to negative highlights areas that + // does not lead to the models's current prediction. + // "BOTH" - Shows both positive and negative attributions. + Polarity string `json:"polarity,omitempty"` + + // Type: Type of the image visualization. Only applicable to Integrated + // Gradients attribution. OUTLINES shows regions of attribution, while + // PIXELS shows per-pixel attribution. Defaults to OUTLINES. + // + // Possible values: + // "TYPE_UNSPECIFIED" - Should not be used. + // "PIXELS" - Shows which pixel contributed to the image prediction. + // "OUTLINES" - Shows which region contributed to the image prediction + // by outlining the region. + Type string `json:"type,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ClipPercentLowerbound") 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. "ClipPercentLowerbound") 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 *XPSVisualization) MarshalJSON() ([]byte, error) { + type NoMethod XPSVisualization + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVisualization) UnmarshalJSON(data []byte) error { + type NoMethod XPSVisualization + var s1 struct { + ClipPercentLowerbound gensupport.JSONFloat64 `json:"clipPercentLowerbound"` + ClipPercentUpperbound gensupport.JSONFloat64 `json:"clipPercentUpperbound"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ClipPercentLowerbound = float64(s1.ClipPercentLowerbound) + s.ClipPercentUpperbound = float64(s1.ClipPercentUpperbound) + return nil +} + +type XPSXpsOperationMetadata struct { + // ExampleCount: Optional. XPS server can opt to provide example count + // of the long running operation (e.g. training, data importing, batch + // prediction). + ExampleCount int64 `json:"exampleCount,omitempty,string"` + + // ReportingMetrics: Metrics for the operation. By the time the + // operation is terminated (whether succeeded or failed) as returned + // from XPS, AutoML BE assumes the metrics are finalized. AutoML BE + // transparently posts the metrics to Chemist if it's not empty, + // regardless of the response content or error type. If user is supposed + // to be charged in case of cancellation/error, this field should be + // set. In the case where the type of LRO doesn't require any billing, + // this field should be left unset. + ReportingMetrics *XPSReportingMetrics `json:"reportingMetrics,omitempty"` + + TablesTrainingOperationMetadata *XPSTablesTrainingOperationMetadata `json:"tablesTrainingOperationMetadata,omitempty"` + + VideoBatchPredictOperationMetadata *XPSVideoBatchPredictOperationMetadata `json:"videoBatchPredictOperationMetadata,omitempty"` + + VideoTrainingOperationMetadata *XPSVideoTrainingOperationMetadata `json:"videoTrainingOperationMetadata,omitempty"` + + VisionTrainingOperationMetadata *XPSVisionTrainingOperationMetadata `json:"visionTrainingOperationMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExampleCount") 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. "ExampleCount") 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 *XPSXpsOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSXpsOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSXraiAttribution: An explanation method that redistributes +// Integrated Gradients attributions to segmented regions, taking +// advantage of the model's fully differentiable structure. Refer to +// this paper for more details: https://arxiv.org/abs/1906.02825 Only +// supports image Models (modality is IMAGE). +type XPSXraiAttribution struct { + // StepCount: The number of steps for approximating the path integral. A + // good value to start is 50 and gradually increase until the sum to + // diff property is met within the desired error range. Valid range of + // its value is [1, 100], inclusively. + StepCount int64 `json:"stepCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "StepCount") 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. "StepCount") 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 *XPSXraiAttribution) MarshalJSON() ([]byte, error) { + type NoMethod XPSXraiAttribution raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } diff --git a/language/v2/language-api.json b/language/v2/language-api.json index 88b57e50812..92e7548782d 100644 --- a/language/v2/language-api.json +++ b/language/v2/language-api.json @@ -208,7 +208,7 @@ } } }, - "revision": "20240217", + "revision": "20240220", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -338,12 +338,35 @@ "type": "string" }, "features": { - "$ref": "Features", + "$ref": "AnnotateTextRequestFeatures", "description": "Required. The enabled features." } }, "type": "object" }, + "AnnotateTextRequestFeatures": { + "description": "All available features. Setting each one to true will enable that specific analysis for the input.", + "id": "AnnotateTextRequestFeatures", + "properties": { + "classifyText": { + "description": "Optional. Classify the full document into categories.", + "type": "boolean" + }, + "extractDocumentSentiment": { + "description": "Optional. Extract document-level sentiment.", + "type": "boolean" + }, + "extractEntities": { + "description": "Optional. Extract entities.", + "type": "boolean" + }, + "moderateText": { + "description": "Optional. Moderate the document for harmful and sensitive categories.", + "type": "boolean" + } + }, + "type": "object" + }, "AnnotateTextResponse": { "description": "The text annotations response message.", "id": "AnnotateTextResponse", @@ -440,6 +463,450 @@ }, "type": "object" }, + "Color": { + "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:\u0026red green:\u0026green blue:\u0026blue alpha:\u0026alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", + "id": "Color", + "properties": { + "alpha": { + "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", + "format": "float", + "type": "number" + }, + "blue": { + "description": "The amount of blue in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "green": { + "description": "The amount of green in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CpuMetric": { + "description": "Metric for billing reports.", + "id": "CpuMetric", + "properties": { + "coreNumber": { + "description": "Required. Number of CPU cores.", + "format": "int64", + "type": "string" + }, + "coreSec": { + "description": "Required. Total seconds of core usage, e.g. 4.", + "format": "int64", + "type": "string" + }, + "cpuType": { + "description": "Required. Type of cpu, e.g. N2.", + "enum": [ + "UNKNOWN_CPU_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "GPU-based machine, skip quota reporting.", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, + "DiskMetric": { + "id": "DiskMetric", + "properties": { + "diskType": { + "description": "Required. Type of Disk, e.g. REGIONAL_SSD.", + "enum": [ + "UNKNOWN_DISK_TYPE", + "REGIONAL_SSD", + "REGIONAL_STORAGE", + "PD_SSD", + "PD_STANDARD", + "STORAGE_SNAPSHOT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "gibSec": { + "description": "Required. Seconds of physical disk usage, e.g. 3600.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Document": { "description": "Represents the input to API methods.", "id": "Document", @@ -570,25 +1037,414 @@ }, "type": "object" }, - "Features": { - "description": "All available features. Setting each one to true will enable that specific analysis for the input.", - "id": "Features", + "GpuMetric": { + "id": "GpuMetric", "properties": { - "classifyText": { - "description": "Optional. Classify the full document into categories.", - "type": "boolean" + "gpuSec": { + "description": "Required. Seconds of GPU usage, e.g. 3600.", + "format": "int64", + "type": "string" }, - "extractDocumentSentiment": { - "description": "Optional. Extract document-level sentiment.", - "type": "boolean" + "gpuType": { + "description": "Required. Type of GPU, e.g. NVIDIA_TESLA_V100.", + "enum": [ + "UNKNOWN_GPU_TYPE", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_TESLA_K80", + "NVIDIA_L4", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_V100", + "NVIDIA_H100_80GB" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "extractEntities": { - "description": "Optional. Extract entities.", - "type": "boolean" + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" }, - "moderateText": { - "description": "Optional. Moderate the document for harmful and sensitive categories.", - "type": "boolean" + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, + "InfraUsage": { + "description": "Infra Usage of billing metrics. Next ID: 6", + "id": "InfraUsage", + "properties": { + "cpuMetrics": { + "description": "Aggregated core metrics since requested start_time.", + "items": { + "$ref": "CpuMetric" + }, + "type": "array" + }, + "diskMetrics": { + "description": "Aggregated persistent disk metrics since requested start_time.", + "items": { + "$ref": "DiskMetric" + }, + "type": "array" + }, + "gpuMetrics": { + "description": "Aggregated gpu metrics since requested start_time.", + "items": { + "$ref": "GpuMetric" + }, + "type": "array" + }, + "ramMetrics": { + "description": "Aggregated ram metrics since requested start_time.", + "items": { + "$ref": "RamMetric" + }, + "type": "array" + }, + "tpuMetrics": { + "description": "Aggregated tpu metrics since requested start_time.", + "items": { + "$ref": "TpuMetric" + }, + "type": "array" } }, "type": "object" @@ -626,6 +1482,391 @@ }, "type": "object" }, + "RamMetric": { + "id": "RamMetric", + "properties": { + "gibSec": { + "description": "Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type to match billing metrics definition.", + "format": "int64", + "type": "string" + }, + "machineSpec": { + "description": "Required. Machine spec, e.g. N1_STANDARD_4.", + "enum": [ + "UNKNOWN_MACHINE_SPEC", + "N1_STANDARD_2", + "N1_STANDARD_4", + "N1_STANDARD_8", + "N1_STANDARD_16", + "N1_STANDARD_32", + "N1_STANDARD_64", + "N1_STANDARD_96", + "N1_HIGHMEM_2", + "N1_HIGHMEM_4", + "N1_HIGHMEM_8", + "N1_HIGHMEM_16", + "N1_HIGHMEM_32", + "N1_HIGHMEM_64", + "N1_HIGHMEM_96", + "N1_HIGHCPU_2", + "N1_HIGHCPU_4", + "N1_HIGHCPU_8", + "N1_HIGHCPU_16", + "N1_HIGHCPU_32", + "N1_HIGHCPU_64", + "N1_HIGHCPU_96", + "A2_HIGHGPU_1G", + "A2_HIGHGPU_2G", + "A2_HIGHGPU_4G", + "A2_HIGHGPU_8G", + "A2_MEGAGPU_16G", + "A2_ULTRAGPU_1G", + "A2_ULTRAGPU_2G", + "A2_ULTRAGPU_4G", + "A2_ULTRAGPU_8G", + "A3_HIGHGPU_8G", + "E2_STANDARD_2", + "E2_STANDARD_4", + "E2_STANDARD_8", + "E2_STANDARD_16", + "E2_STANDARD_32", + "E2_HIGHMEM_2", + "E2_HIGHMEM_4", + "E2_HIGHMEM_8", + "E2_HIGHMEM_16", + "E2_HIGHCPU_2", + "E2_HIGHCPU_4", + "E2_HIGHCPU_8", + "E2_HIGHCPU_16", + "E2_HIGHCPU_32", + "N2_STANDARD_2", + "N2_STANDARD_4", + "N2_STANDARD_8", + "N2_STANDARD_16", + "N2_STANDARD_32", + "N2_STANDARD_48", + "N2_STANDARD_64", + "N2_STANDARD_80", + "N2_STANDARD_96", + "N2_STANDARD_128", + "N2_HIGHMEM_2", + "N2_HIGHMEM_4", + "N2_HIGHMEM_8", + "N2_HIGHMEM_16", + "N2_HIGHMEM_32", + "N2_HIGHMEM_48", + "N2_HIGHMEM_64", + "N2_HIGHMEM_80", + "N2_HIGHMEM_96", + "N2_HIGHMEM_128", + "N2_HIGHCPU_2", + "N2_HIGHCPU_4", + "N2_HIGHCPU_8", + "N2_HIGHCPU_16", + "N2_HIGHCPU_32", + "N2_HIGHCPU_48", + "N2_HIGHCPU_64", + "N2_HIGHCPU_80", + "N2_HIGHCPU_96", + "N2D_STANDARD_2", + "N2D_STANDARD_4", + "N2D_STANDARD_8", + "N2D_STANDARD_16", + "N2D_STANDARD_32", + "N2D_STANDARD_48", + "N2D_STANDARD_64", + "N2D_STANDARD_80", + "N2D_STANDARD_96", + "N2D_STANDARD_128", + "N2D_STANDARD_224", + "N2D_HIGHMEM_2", + "N2D_HIGHMEM_4", + "N2D_HIGHMEM_8", + "N2D_HIGHMEM_16", + "N2D_HIGHMEM_32", + "N2D_HIGHMEM_48", + "N2D_HIGHMEM_64", + "N2D_HIGHMEM_80", + "N2D_HIGHMEM_96", + "N2D_HIGHCPU_2", + "N2D_HIGHCPU_4", + "N2D_HIGHCPU_8", + "N2D_HIGHCPU_16", + "N2D_HIGHCPU_32", + "N2D_HIGHCPU_48", + "N2D_HIGHCPU_64", + "N2D_HIGHCPU_80", + "N2D_HIGHCPU_96", + "N2D_HIGHCPU_128", + "N2D_HIGHCPU_224", + "C2_STANDARD_4", + "C2_STANDARD_8", + "C2_STANDARD_16", + "C2_STANDARD_30", + "C2_STANDARD_60", + "C2D_STANDARD_2", + "C2D_STANDARD_4", + "C2D_STANDARD_8", + "C2D_STANDARD_16", + "C2D_STANDARD_32", + "C2D_STANDARD_56", + "C2D_STANDARD_112", + "C2D_HIGHCPU_2", + "C2D_HIGHCPU_4", + "C2D_HIGHCPU_8", + "C2D_HIGHCPU_16", + "C2D_HIGHCPU_32", + "C2D_HIGHCPU_56", + "C2D_HIGHCPU_112", + "C2D_HIGHMEM_2", + "C2D_HIGHMEM_4", + "C2D_HIGHMEM_8", + "C2D_HIGHMEM_16", + "C2D_HIGHMEM_32", + "C2D_HIGHMEM_56", + "C2D_HIGHMEM_112", + "G2_STANDARD_4", + "G2_STANDARD_8", + "G2_STANDARD_12", + "G2_STANDARD_16", + "G2_STANDARD_24", + "G2_STANDARD_32", + "G2_STANDARD_48", + "G2_STANDARD_96", + "C3_STANDARD_4", + "C3_STANDARD_8", + "C3_STANDARD_22", + "C3_STANDARD_44", + "C3_STANDARD_88", + "C3_STANDARD_176", + "C3_HIGHCPU_4", + "C3_HIGHCPU_8", + "C3_HIGHCPU_22", + "C3_HIGHCPU_44", + "C3_HIGHCPU_88", + "C3_HIGHCPU_176", + "C3_HIGHMEM_4", + "C3_HIGHMEM_8", + "C3_HIGHMEM_22", + "C3_HIGHMEM_44", + "C3_HIGHMEM_88", + "C3_HIGHMEM_176" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "memories": { + "description": "Required. VM memory in gb.", + "format": "double", + "type": "number" + }, + "ramType": { + "description": "Required. Type of ram.", + "enum": [ + "UNKNOWN_RAM_TYPE", + "A2", + "A3", + "C2", + "C2D", + "CUSTOM", + "E2", + "G2", + "C3", + "M2", + "M1", + "N1", + "N2_CUSTOM", + "N2", + "N2D" + ], + "enumDescriptions": [ + "", + "", + "", + "COMPUTE_OPTIMIZED", + "", + "", + "", + "", + "", + "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", + "MEMORY_OPTIMIZED", + "", + "", + "", + "" + ], + "type": "string" + }, + "trackingLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Billing tracking labels. They do not contain any user data but only the labels set by Vertex Core Infra itself. Tracking labels' keys are defined with special format: goog-[\\p{Ll}\\p{N}]+ E.g. \"key\": \"goog-k8s-cluster-name\",\"value\": \"us-east1-b4rk\"", + "type": "object" + } + }, + "type": "object" + }, "Sentence": { "description": "Represents a sentence in the input document.", "id": "Sentence", @@ -700,6 +1941,3080 @@ } }, "type": "object" + }, + "TpuMetric": { + "id": "TpuMetric", + "properties": { + "tpuSec": { + "description": "Required. Seconds of TPU usage, e.g. 3600.", + "format": "int64", + "type": "string" + }, + "tpuType": { + "description": "Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD.", + "enum": [ + "UNKNOWN_TPU_TYPE", + "TPU_V2_POD", + "TPU_V2", + "TPU_V3_POD", + "TPU_V3", + "TPU_V5_LITEPOD" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSArrayStats": { + "description": "The data statistics of a series of ARRAY values.", + "id": "XPSArrayStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "memberStats": { + "$ref": "XPSDataStats", + "description": "Stats of all the values of all arrays, as if they were a single long series of data. The type depends on the element type of the array." + } + }, + "type": "object" + }, + "XPSBatchPredictResponse": { + "id": "XPSBatchPredictResponse", + "properties": { + "exampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples for batch prediction result. Under full API implementation, results are stored in shared RecordIO of AnnotatedExample protobufs, the annotations field of which is populated by XPS backend." + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntry": { + "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", + "id": "XPSBoundingBoxMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "The intersection-over-union threshold value used to compute this metrics entry.", + "format": "float", + "type": "number" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSBoundingBoxMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSCategoryStats": { + "description": "The data statistics of a series of CATEGORY values.", + "id": "XPSCategoryStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topCategoryStats": { + "description": "The statistics of the top 20 CATEGORY values, ordered by CategoryStats.SingleCategoryStats.count.", + "items": { + "$ref": "XPSCategoryStatsSingleCategoryStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCategoryStatsSingleCategoryStats": { + "description": "The statistics of a single CATEGORY value.", + "id": "XPSCategoryStatsSingleCategoryStats", + "properties": { + "count": { + "description": "The number of occurrences of this value in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The CATEGORY value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSClassificationEvaluationMetrics": { + "description": "Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9.", + "id": "XPSClassificationEvaluationMetrics", + "properties": { + "auPrc": { + "description": "The Area under precision recall curve metric.", + "format": "float", + "type": "number" + }, + "auRoc": { + "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", + "format": "float", + "type": "number" + }, + "baseAuPrc": { + "description": "The Area under precision recall curve metric based on priors.", + "format": "float", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the evaluation. Only set for MULTICLASS classification problems where number of annotation specs is no more than 10. Only set for model level evaluation, not for evaluation per label." + }, + "evaluatedExamplesCount": { + "description": "The number of examples used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "logLoss": { + "description": "The Log Loss metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSColorMap": { + "description": "Map from color to display name. Will only be used by Image Segmentation for uCAIP.", + "id": "XPSColorMap", + "properties": { + "annotationSpecIdToken": { + "description": "Should be used during training.", + "type": "string" + }, + "color": { + "$ref": "Color", + "deprecated": true, + "description": "This type is deprecated in favor of the IntColor below. This is because google.type.Color represent color has a float which semantically does not reflect discrete classes/categories concept. Moreover, to handle it well we need to have some tolerance when converting to a discretized color. As such, the recommendation is to have API surface still use google.type.Color while internally IntColor is used." + }, + "displayName": { + "description": "Should be used during preprocessing.", + "type": "string" + }, + "intColor": { + "$ref": "XPSColorMapIntColor" + } + }, + "type": "object" + }, + "XPSColorMapIntColor": { + "description": "RGB color and each channel is represented by an integer.", + "id": "XPSColorMapIntColor", + "properties": { + "blue": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "green": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + }, + "red": { + "description": "The value should be in range of [0, 255].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSColumnSpec": { + "id": "XPSColumnSpec", + "properties": { + "columnId": { + "description": "The unique id of the column. When Preprocess, the Tables BE will popuate the order id of the column, which reflects the order of the column inside the table, i.e. 0 means the first column in the table, N-1 means the last column. AutoML BE will persist this order id in Spanner and set the order id here when calling RefreshTablesStats and Train. Note: it's different than the column_spec_id that is generated in AutoML BE.", + "format": "int32", + "type": "integer" + }, + "dataStats": { + "$ref": "XPSDataStats", + "description": "The data stats of the column. It's outputed in RefreshTablesStats and a required input for Train." + }, + "dataType": { + "$ref": "XPSDataType", + "description": "The data type of the column. It's outputed in Preprocess rpc and a required input for RefreshTablesStats and Train." + }, + "displayName": { + "description": "The display name of the column. It's outputed in Preprocess and a required input for RefreshTablesStats and Train.", + "type": "string" + }, + "forecastingMetadata": { + "$ref": "XPSColumnSpecForecastingMetadata" + }, + "topCorrelatedColumns": { + "description": "It's outputed in RefreshTablesStats, and a required input in Train.", + "items": { + "$ref": "XPSColumnSpecCorrelatedColumn" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSColumnSpecCorrelatedColumn": { + "description": "Identifies a table's column, and its correlation with the column this ColumnSpec describes.", + "id": "XPSColumnSpecCorrelatedColumn", + "properties": { + "columnId": { + "format": "int32", + "type": "integer" + }, + "correlationStats": { + "$ref": "XPSCorrelationStats" + } + }, + "type": "object" + }, + "XPSColumnSpecForecastingMetadata": { + "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", + "id": "XPSColumnSpecForecastingMetadata", + "properties": { + "columnType": { + "description": "The type of the column for FORECASTING model training purposes.", + "enum": [ + "COLUMN_TYPE_UNSPECIFIED", + "KEY", + "KEY_METADATA", + "TIME_SERIES_AVAILABLE_PAST_ONLY", + "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" + ], + "enumDescriptions": [ + "An un-set value of this enum.", + "Key columns are used to identify timeseries.", + "This column contains information describing static properties of the entities identified by the key column(s) (e.g. city's ZIP code).", + "This column contains information for the given entity, at any time poinrt, they are only available in the time series before.", + "This column contains information for the given entity is known both for the past and the sufficiently far future." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSCommonStats": { + "description": "Common statistics for a column with a specified data type.", + "id": "XPSCommonStats", + "properties": { + "distinctValueCount": { + "format": "int64", + "type": "string" + }, + "nullValueCount": { + "format": "int64", + "type": "string" + }, + "validValueCount": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfidenceMetricsEntry": { + "description": "ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16.", + "id": "XPSConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the model never return predictions with score lower than this value.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recall_at1 and precision_at1.", + "format": "float", + "type": "number" + }, + "falseNegativeCount": { + "description": "The number of ground truth labels that are not matched by a model created label.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "The number of model created labels that do not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "False Positive Rate for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "falsePositiveRateAt1": { + "description": "The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "positionThreshold": { + "description": "Metrics are computed with an assumption that the model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidence_threshold.", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (true positive rate) for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "description": "The recall (true positive rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each example.", + "format": "float", + "type": "number" + }, + "trueNegativeCount": { + "description": "The number of labels that were not created by the model, but if they would, they would not match a ground truth label.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "The number of model created labels that match a ground truth label.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSConfusionMatrix": { + "description": "Confusion matrix of the model running the classification.", + "id": "XPSConfusionMatrix", + "properties": { + "annotationSpecIdToken": { + "description": "For the following three repeated fields, only one is intended to be set. annotation_spec_id_token is preferable to be set. ID tokens of the annotation specs used in the confusion matrix.", + "items": { + "type": "string" + }, + "type": "array" + }, + "category": { + "description": "Category (mainly for segmentation). Set only for image segmentation models. Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "row": { + "description": "Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated.", + "items": { + "$ref": "XPSConfusionMatrixRow" + }, + "type": "array" + }, + "sentimentLabel": { + "description": "Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSConfusionMatrixRow": { + "description": "A row in the confusion matrix.", + "id": "XPSConfusionMatrixRow", + "properties": { + "count": { + "description": "Same as above except intended to represent other counts (for e.g. for segmentation this is pixel count). NOTE(params): Only example_count or count is set (oneoff does not support repeated fields unless they are embedded inside another message).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "exampleCount": { + "description": "Value of the specific cell in the confusion matrix. The number of values each row has (i.e. the length of the row) is equal to the length of the annotation_spec_id_token field.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSCoreMlFormat": { + "description": "A model format used for iOS mobile devices.", + "id": "XPSCoreMlFormat", + "properties": {}, + "type": "object" + }, + "XPSCorrelationStats": { + "description": "A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same.", + "id": "XPSCorrelationStats", + "properties": { + "cramersV": { + "description": "The correlation value using the Cramer's V measure.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSDataErrors": { + "description": "Different types of errors and the stats associatesd with each error.", + "id": "XPSDataErrors", + "properties": { + "count": { + "description": "Number of records having errors associated with the enum.", + "format": "int32", + "type": "integer" + }, + "errorType": { + "description": "Type of the error.", + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "UNSUPPORTED_AUDIO_FORMAT", + "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT", + "FILE_TOO_LARGE", + "MISSING_TRANSCRIPTION" + ], + "enumDescriptions": [ + "Not specified.", + "Audio format not in the formats by cloud-speech AutoML. Currently only wav and flac file formats are supported.", + "File format differnt from what is specified in the file name extension.", + "File too large. Maximum allowed size is 50 MB.", + "Transcript is missing." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDataStats": { + "description": "The data statistics of a series of values that share the same DataType.", + "id": "XPSDataStats", + "properties": { + "arrayStats": { + "$ref": "XPSArrayStats", + "description": "The statistics for ARRAY DataType." + }, + "categoryStats": { + "$ref": "XPSCategoryStats", + "description": "The statistics for CATEGORY DataType." + }, + "distinctValueCount": { + "description": "The number of distinct values.", + "format": "int64", + "type": "string" + }, + "float64Stats": { + "$ref": "XPSFloat64Stats", + "description": "The statistics for FLOAT64 DataType." + }, + "nullValueCount": { + "description": "The number of values that are null.", + "format": "int64", + "type": "string" + }, + "stringStats": { + "$ref": "XPSStringStats", + "description": "The statistics for STRING DataType." + }, + "structStats": { + "$ref": "XPSStructStats", + "description": "The statistics for STRUCT DataType." + }, + "timestampStats": { + "$ref": "XPSTimestampStats", + "description": "The statistics for TIMESTAMP DataType." + }, + "validValueCount": { + "description": "The number of values that are valid.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSDataType": { + "description": "Indicated the type of data that can be stored in a structured data entity (e.g. a table).", + "id": "XPSDataType", + "properties": { + "compatibleDataTypes": { + "description": "The highly compatible data types to this data type.", + "items": { + "$ref": "XPSDataType" + }, + "type": "array" + }, + "listElementType": { + "$ref": "XPSDataType", + "description": "If type_code == ARRAY, then `list_element_type` is the type of the elements." + }, + "nullable": { + "description": "If true, this DataType can also be `null`.", + "type": "boolean" + }, + "structType": { + "$ref": "XPSStructType", + "description": "If type_code == STRUCT, then `struct_type` provides type information for the struct's fields." + }, + "timeFormat": { + "description": "If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must be written in `strftime` syntax. If time_format is not set, then the default format as described on the field is used.", + "type": "string" + }, + "typeCode": { + "description": "Required. The TypeCode for this type.", + "enum": [ + "TYPE_CODE_UNSPECIFIED", + "FLOAT64", + "TIMESTAMP", + "STRING", + "ARRAY", + "STRUCT", + "CATEGORY" + ], + "enumDescriptions": [ + "Not specified. Should not be used.", + "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or `\"-Infinity\"`.", + "Must be between 0AD and 9999AD. Encoded as `string` according to time_format, or, if that format is not set, then in RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z).", + "Encoded as `string`.", + "Encoded as `list`, where the list elements are represented according to list_element_type.", + "Encoded as `struct`, where field values are represented according to struct_type.", + "Values of this type are not further understood by AutoML, e.g. AutoML is unable to tell the order of values (as it could with FLOAT64), or is unable to say if one value contains another (as it could with STRING). Encoded as `string` (bytes should be base64-encoded, as described in RFC 4648, section 4)." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSDockerFormat": { + "description": "A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system.", + "id": "XPSDockerFormat", + "properties": { + "cpuArchitecture": { + "description": "Optional. Additional cpu information describing the requirements for the to be exported model files.", + "enum": [ + "CPU_ARCHITECTURE_UNSPECIFIED", + "CPU_ARCHITECTURE_X86_64" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "gpuArchitecture": { + "description": "Optional. Additional gpu information describing the requirements for the to be exported model files.", + "enum": [ + "GPU_ARCHITECTURE_UNSPECIFIED", + "GPU_ARCHITECTURE_NVIDIA" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSEdgeTpuTfLiteFormat": { + "description": "A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "id": "XPSEdgeTpuTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSEvaluationMetrics": { + "description": "Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18.", + "id": "XPSEvaluationMetrics", + "properties": { + "annotationSpecIdToken": { + "description": "The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead.", + "type": "string" + }, + "category": { + "description": "The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token.", + "format": "int32", + "type": "integer" + }, + "evaluatedExampleCount": { + "description": "The number of examples used to create this evaluation metrics instance.", + "format": "int32", + "type": "integer" + }, + "imageClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "imageObjectDetectionEvalMetrics": { + "$ref": "XPSImageObjectDetectionEvaluationMetrics" + }, + "imageSegmentationEvalMetrics": { + "$ref": "XPSImageSegmentationEvaluationMetrics" + }, + "label": { + "description": "The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation.", + "type": "string" + }, + "regressionEvalMetrics": { + "$ref": "XPSRegressionEvaluationMetrics" + }, + "tablesClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "tablesEvalMetrics": { + "$ref": "XPSTablesEvaluationMetrics" + }, + "textClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "textExtractionEvalMetrics": { + "$ref": "XPSTextExtractionEvaluationMetrics" + }, + "textSentimentEvalMetrics": { + "$ref": "XPSTextSentimentEvaluationMetrics" + }, + "translationEvalMetrics": { + "$ref": "XPSTranslationEvaluationMetrics" + }, + "videoActionRecognitionEvalMetrics": { + "$ref": "XPSVideoActionRecognitionEvaluationMetrics" + }, + "videoClassificationEvalMetrics": { + "$ref": "XPSClassificationEvaluationMetrics" + }, + "videoObjectTrackingEvalMetrics": { + "$ref": "XPSVideoObjectTrackingEvaluationMetrics" + } + }, + "type": "object" + }, + "XPSEvaluationMetricsSet": { + "description": "Specifies location of model evaluation metrics.", + "id": "XPSEvaluationMetricsSet", + "properties": { + "evaluationMetrics": { + "description": "Inline EvaluationMetrics - should be relatively small. For passing large quantities of exhaustive metrics, use file_spec.", + "items": { + "$ref": "XPSEvaluationMetrics" + }, + "type": "array" + }, + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec containing evaluation metrics of a model, must point to RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics messages." + }, + "numEvaluationMetrics": { + "description": "Number of the evaluation metrics (usually one per label plus overall).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExampleSet": { + "description": "Set of examples or input sources.", + "id": "XPSExampleSet", + "properties": { + "fileSpec": { + "$ref": "XPSFileSpec", + "description": "File spec of the examples or input sources." + }, + "fingerprint": { + "description": "Fingerprint of the example set.", + "format": "int64", + "type": "string" + }, + "numExamples": { + "description": "Number of examples.", + "format": "int64", + "type": "string" + }, + "numInputSources": { + "description": "Number of input sources.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSExportModelOutputConfig": { + "id": "XPSExportModelOutputConfig", + "properties": { + "coreMlFormat": { + "$ref": "XPSCoreMlFormat" + }, + "dockerFormat": { + "$ref": "XPSDockerFormat" + }, + "edgeTpuTfLiteFormat": { + "$ref": "XPSEdgeTpuTfLiteFormat" + }, + "exportFirebaseAuxiliaryInfo": { + "description": "For any model and format: If true, will additionally export FirebaseExportedModelInfo in a firebase.txt file.", + "type": "boolean" + }, + "outputGcrUri": { + "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "type": "string" + }, + "outputGcsUri": { + "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "type": "string" + }, + "tfJsFormat": { + "$ref": "XPSTfJsFormat" + }, + "tfLiteFormat": { + "$ref": "XPSTfLiteFormat" + }, + "tfSavedModelFormat": { + "$ref": "XPSTfSavedModelFormat" + } + }, + "type": "object" + }, + "XPSFileSpec": { + "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "id": "XPSFileSpec", + "properties": { + "directoryPath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + }, + "fileFormat": { + "enum": [ + "FILE_FORMAT_UNKNOWN", + "FILE_FORMAT_SSTABLE", + "FILE_FORMAT_TRANSLATION_RKV", + "FILE_FORMAT_RECORDIO", + "FILE_FORMAT_RAW_CSV", + "FILE_FORMAT_RAW_CAPACITOR" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false + ], + "enumDescriptions": [ + "", + "", + "Internal format for parallel text data used by Google Translate. go/rkvtools", + "", + "Only the lexicographically first file described by the file_spec contains the header line.", + "" + ], + "type": "string" + }, + "fileSpec": { + "description": "Single file path, or file pattern of format \"/path/to/file@shard_count\". E.g. /cns/cell-d/somewhere/file@2 is expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and /cns/cell-d/somewhere/file-00001-of-00002.", + "type": "string" + }, + "singleFilePath": { + "deprecated": true, + "description": "Deprecated. Use file_spec.", + "type": "string" + } + }, + "type": "object" + }, + "XPSFloat64Stats": { + "description": "The data statistics of a series of FLOAT64 values.", + "id": "XPSFloat64Stats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "histogramBuckets": { + "description": "Histogram buckets of the data series. Sorted by the min value of the bucket, ascendingly, and the number of the buckets is dynamically generated. The buckets are non-overlapping and completely cover whole FLOAT64 range with min of first bucket being `\"-Infinity\"`, and max of the last one being `\"Infinity\"`.", + "items": { + "$ref": "XPSFloat64StatsHistogramBucket" + }, + "type": "array" + }, + "mean": { + "description": "The mean of the series.", + "format": "double", + "type": "number" + }, + "quantiles": { + "description": "Ordered from 0 to k k-quantile values of the data series of n values. The value at index i is, approximately, the i*n/k-th smallest value in the series; for i = 0 and i = k these are, respectively, the min and max values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "standardDeviation": { + "description": "The standard deviation of the series.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSFloat64StatsHistogramBucket": { + "description": "A bucket of a histogram.", + "id": "XPSFloat64StatsHistogramBucket", + "properties": { + "count": { + "description": "The number of data values that are in the bucket, i.e. are between min and max values.", + "format": "int64", + "type": "string" + }, + "max": { + "description": "The maximum value of the bucket, exclusive unless max = `\"Infinity\"`, in which case it's inclusive.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value of the bucket, inclusive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageClassificationTrainResponse": { + "id": "XPSImageClassificationTrainResponse", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Populated for AutoMl requests." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostInNodeTime": { + "description": "The actual cost to create this model. - For edge type model, the cost is expressed in node hour. - For cloud type model,the cost is expressed in compute hour. - Populated for models created before GA. To be deprecated after GA.", + "format": "google-duration", + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual training cost, expressed in node seconds. Populated for models trained in node time.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSImageExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageModelArtifactSpec": { + "description": "Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only.", + "id": "XPSImageModelArtifactSpec", + "properties": { + "checkpointArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The Tensorflow checkpoint files. e.g. Used for resumable training." + }, + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "labelGcsUri": { + "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." + }, + "tfJsBinaryGcsPrefix": { + "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "type": "string" + }, + "tfLiteMetadataGcsUri": { + "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpec": { + "description": "Serving specification for image models.", + "id": "XPSImageModelServingSpec", + "properties": { + "modelThroughputEstimation": { + "description": "Populate under uCAIP request scope.", + "items": { + "$ref": "XPSImageModelServingSpecModelThroughputEstimation" + }, + "type": "array" + }, + "nodeQps": { + "description": "An estimated value of how much traffic a node can serve. Populated for AutoMl request only.", + "format": "double", + "type": "number" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageModelServingSpecModelThroughputEstimation": { + "id": "XPSImageModelServingSpecModelThroughputEstimation", + "properties": { + "computeEngineAcceleratorType": { + "enum": [ + "UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", + "NVIDIA_A100_80GB", + "NVIDIA_L4", + "NVIDIA_H100_80GB", + "TPU_V2", + "TPU_V3", + "TPU_V4_POD", + "TPU_V5_LITEPOD" + ], + "enumDescriptions": [ + "", + "Nvidia Tesla K80 GPU.", + "Nvidia Tesla P100 GPU.", + "Nvidia Tesla V100 GPU.", + "Nvidia Tesla P4 GPU.", + "Nvidia Tesla T4 GPU.", + "Nvidia Tesla A100 GPU.", + "Nvidia A100 80GB GPU.", + "Nvidia L4 GPU.", + "Nvidia H100 80Gb GPU.", + "TPU v2 (JellyFish).", + "TPU v3 (DragonFish).", + "TPU_v4 (PufferFish).", + "TPU v5 Lite Pods." + ], + "type": "string" + }, + "latencyInMilliseconds": { + "description": "Estimated latency.", + "format": "double", + "type": "number" + }, + "nodeQps": { + "description": "The approximate qps a deployed node can serve.", + "format": "double", + "type": "number" + }, + "servomaticPartitionType": { + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionEvaluationMetrics": { + "description": "Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes.", + "id": "XPSImageObjectDetectionEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingBoxCount": { + "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSImageObjectDetectionModelSpec": { + "id": "XPSImageObjectDetectionModelSpec", + "properties": { + "classCount": { + "description": "Total number of classes.", + "format": "int64", + "type": "string" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec" + }, + "maxBoundingBoxCount": { + "description": "Max number of bounding box.", + "format": "int64", + "type": "string" + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetrics": { + "description": "Model evaluation metrics for image segmentation problems. Next tag: 4.", + "id": "XPSImageSegmentationEvaluationMetrics", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from it.", + "items": { + "$ref": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the per confidence_threshold evaluation. Pixel counts are set here. Only set for model level evaluation, not for evaluation per label." + }, + "diceScoreCoefficient": { + "description": "DSC or the F1 score: The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "iouScore": { + "description": "IOU score.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSImageSegmentationTrainResponse": { + "id": "XPSImageSegmentationTrainResponse", + "properties": { + "colorMaps": { + "description": "Color map of the model.", + "items": { + "$ref": "XPSColorMap" + }, + "type": "array" + }, + "exportModelSpec": { + "$ref": "XPSImageExportModelSpec", + "description": "NOTE: These fields are not used/needed in EAP but will be set later." + }, + "modelArtifactSpec": { + "$ref": "XPSImageModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope. Model artifact spec stores and model gcs pathes and related metadata" + }, + "modelServingSpec": { + "$ref": "XPSImageModelServingSpec" + }, + "stopReason": { + "description": "Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'.", + "enum": [ + "TRAIN_STOP_REASON_UNSPECIFIED", + "TRAIN_STOP_REASON_BUDGET_REACHED", + "TRAIN_STOP_REASON_MODEL_CONVERGED", + "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" + ], + "enumDescriptions": [ + "", + "", + "Model fully converged, can not be resumbed training.", + "Model early converged, can be further trained till full convergency." + ], + "type": "string" + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSIntegratedGradientsAttribution": { + "deprecated": true, + "description": "An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365", + "id": "XPSIntegratedGradientsAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSMetricEntry": { + "id": "XPSMetricEntry", + "properties": { + "argentumMetricId": { + "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", + "type": "string" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "systemLabels": { + "description": "Billing system labels for this (metric, value) pair.", + "items": { + "$ref": "XPSMetricEntryLabel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSMetricEntryLabel": { + "id": "XPSMetricEntryLabel", + "properties": { + "labelName": { + "description": "The name of the label.", + "type": "string" + }, + "labelValue": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "XPSModelArtifactItem": { + "description": "A single model artifact item.", + "id": "XPSModelArtifactItem", + "properties": { + "artifactFormat": { + "description": "The model artifact format.", + "enum": [ + "ARTIFACT_FORMAT_UNSPECIFIED", + "TF_CHECKPOINT", + "TF_SAVED_MODEL", + "TF_LITE", + "EDGE_TPU_TF_LITE", + "TF_JS", + "CORE_ML" + ], + "enumDescriptions": [ + "Should not be used.", + "The Tensorflow checkpoints. See https://www.tensorflow.org/guide/checkpoint.", + "The Tensorflow SavedModel binary.", + "Model artifact in generic TensorFlow Lite (.tflite) format. See https://www.tensorflow.org/lite.", + "Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.", + "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "Used for iOS mobile devices in (.mlmodel) format. See https://developer.apple.com/documentation/coreml" + ], + "type": "string" + }, + "gcsUri": { + "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "type": "string" + } + }, + "type": "object" + }, + "XPSPreprocessResponse": { + "description": "Next ID: 8", + "id": "XPSPreprocessResponse", + "properties": { + "outputExampleSet": { + "$ref": "XPSExampleSet", + "description": "Preprocessed examples, that are to be imported into AutoML storage. This should point to RecordIO file(s) of PreprocessedExample messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data." + }, + "speechPreprocessResp": { + "$ref": "XPSSpeechPreprocessResponse" + }, + "tablesPreprocessResponse": { + "$ref": "XPSTablesPreprocessResponse" + }, + "translationPreprocessResp": { + "$ref": "XPSTranslationPreprocessResponse" + } + }, + "type": "object" + }, + "XPSRegressionEvaluationMetrics": { + "description": "Model evaluation metrics for regression problems. It can be used for Tables.", + "id": "XPSRegressionEvaluationMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean Absolute Error (MAE).", + "format": "float", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error. Only set if all ground truth values are positive.", + "format": "float", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "float", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root Mean Squared Error (RMSE).", + "format": "float", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSRegressionMetricsEntry": { + "description": "A pair of actual \u0026 observed values for the model being evaluated.", + "id": "XPSRegressionMetricsEntry", + "properties": { + "predictedValue": { + "description": "The observed value for a row in the dataset.", + "format": "float", + "type": "number" + }, + "trueValue": { + "description": "The actual target value for a row in the dataset.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSReportingMetrics": { + "id": "XPSReportingMetrics", + "properties": { + "effectiveTrainingDuration": { + "deprecated": true, + "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", + "format": "google-duration", + "type": "string" + }, + "metricEntries": { + "description": "One entry per metric name. The values must be aggregated per metric name.", + "items": { + "$ref": "XPSMetricEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadata": { + "deprecated": true, + "id": "XPSResponseExplanationMetadata", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataInputMetadata" + }, + "description": "Metadata of the input.", + "type": "object" + }, + "outputs": { + "additionalProperties": { + "$ref": "XPSResponseExplanationMetadataOutputMetadata" + }, + "description": "Metadata of the output.", + "type": "object" + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataInputMetadata": { + "description": "Metadata of the input of a feature.", + "id": "XPSResponseExplanationMetadataInputMetadata", + "properties": { + "inputTensorName": { + "description": "Name of the input tensor for this model. Only needed in train response.", + "type": "string" + }, + "modality": { + "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.", + "enum": [ + "MODALITY_UNSPECIFIED", + "NUMERIC", + "IMAGE", + "CATEGORICAL" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "visualizationConfig": { + "$ref": "XPSVisualization", + "description": "Visualization configurations for image explanation." + } + }, + "type": "object" + }, + "XPSResponseExplanationMetadataOutputMetadata": { + "description": "Metadata of the prediction output to be explained.", + "id": "XPSResponseExplanationMetadataOutputMetadata", + "properties": { + "outputTensorName": { + "description": "Name of the output tensor. Only needed in train response.", + "type": "string" + } + }, + "type": "object" + }, + "XPSResponseExplanationParameters": { + "deprecated": true, + "id": "XPSResponseExplanationParameters", + "properties": { + "integratedGradientsAttribution": { + "$ref": "XPSIntegratedGradientsAttribution", + "description": "An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365" + }, + "xraiAttribution": { + "$ref": "XPSXraiAttribution", + "description": "An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead." + } + }, + "type": "object" + }, + "XPSResponseExplanationSpec": { + "deprecated": true, + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "id": "XPSResponseExplanationSpec", + "properties": { + "explanationType": { + "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "type": "string" + }, + "metadata": { + "$ref": "XPSResponseExplanationMetadata", + "description": "Metadata describing the Model's input and output for explanation." + }, + "parameters": { + "$ref": "XPSResponseExplanationParameters", + "description": "Parameters that configure explaining of the Model's predictions." + } + }, + "type": "object" + }, + "XPSRow": { + "id": "XPSRow", + "properties": { + "columnIds": { + "description": "The ids of the columns. Note: The below `values` field must match order of this field, if this field is set.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "values": { + "description": "The values of the row cells, given in the same order as the column_ids. If column_ids is not set, then in the same order as the input_feature_column_ids in TablesModelMetadata.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetrics": { + "id": "XPSSpeechEvaluationMetrics", + "properties": { + "subModelEvaluationMetrics": { + "description": "Evaluation metrics for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechEvaluationMetricsSubModelEvaluationMetric": { + "id": "XPSSpeechEvaluationMetricsSubModelEvaluationMetric", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + }, + "numDeletions": { + "format": "int32", + "type": "integer" + }, + "numInsertions": { + "format": "int32", + "type": "integer" + }, + "numSubstitutions": { + "format": "int32", + "type": "integer" + }, + "numUtterances": { + "description": "Number of utterances used in the wer computation.", + "format": "int32", + "type": "integer" + }, + "numWords": { + "description": "Number of words over which the word error rate was computed.", + "format": "int32", + "type": "integer" + }, + "sentenceAccuracy": { + "description": "Below fields are used for debugging purposes", + "format": "double", + "type": "number" + }, + "wer": { + "description": "Word error rate (standard error metric used for speech recognition).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSSpeechModelSpec": { + "id": "XPSSpeechModelSpec", + "properties": { + "datasetId": { + "description": "Required for speech xps backend. Speech xps has to use dataset_id and model_id as the primary key in db so that speech API can query the db directly.", + "format": "int64", + "type": "string" + }, + "language": { + "type": "string" + }, + "subModelSpecs": { + "description": "Model specs for all submodels contained in this model.", + "items": { + "$ref": "XPSSpeechModelSpecSubModelSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSSpeechModelSpecSubModelSpec": { + "id": "XPSSpeechModelSpecSubModelSpec", + "properties": { + "biasingModelType": { + "description": "Type of the biasing model.", + "enum": [ + "BIASING_MODEL_TYPE_UNSPECIFIED", + "COMMAND_AND_SEARCH", + "PHONE_CALL", + "VIDEO", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "Build biasing model on top of COMMAND_AND_SEARCH model", + "Build biasing model on top of PHONE_CALL model", + "Build biasing model on top of VIDEO model", + "Build biasing model on top of DEFAULT model" + ], + "type": "string" + }, + "clientId": { + "description": "In S3, Recognition ClientContextId.client_id", + "type": "string" + }, + "contextId": { + "description": "In S3, Recognition ClientContextId.context_id", + "type": "string" + }, + "isEnhancedModel": { + "description": "If true then it means we have an enhanced version of the biasing models.", + "type": "boolean" + } + }, + "type": "object" + }, + "XPSSpeechPreprocessResponse": { + "id": "XPSSpeechPreprocessResponse", + "properties": { + "cnsTestDataPath": { + "description": "Location od shards of sstables (test data) of DataUtterance protos.", + "type": "string" + }, + "cnsTrainDataPath": { + "description": "Location of shards of sstables (training data) of DataUtterance protos.", + "type": "string" + }, + "prebuiltModelEvaluationMetrics": { + "$ref": "XPSSpeechEvaluationMetrics", + "description": "The metrics for prebuilt speech models. They are included here because there is no prebuilt speech models stored in the AutoML." + }, + "speechPreprocessStats": { + "$ref": "XPSSpeechPreprocessStats", + "description": "Stats associated with the data." + } + }, + "type": "object" + }, + "XPSSpeechPreprocessStats": { + "id": "XPSSpeechPreprocessStats", + "properties": { + "dataErrors": { + "description": "Different types of data errors and the counts associated with them.", + "items": { + "$ref": "XPSDataErrors" + }, + "type": "array" + }, + "numHumanLabeledExamples": { + "description": "The number of rows marked HUMAN_LABELLED", + "format": "int32", + "type": "integer" + }, + "numLogsExamples": { + "description": "The number of samples found in the previously recorded logs data.", + "format": "int32", + "type": "integer" + }, + "numMachineTranscribedExamples": { + "description": "The number of rows marked as MACHINE_TRANSCRIBED", + "format": "int32", + "type": "integer" + }, + "testExamplesCount": { + "description": "The number of examples labelled as TEST by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "testSentencesCount": { + "description": "The number of sentences in the test data set.", + "format": "int32", + "type": "integer" + }, + "testWordsCount": { + "description": "The number of words in the test data set.", + "format": "int32", + "type": "integer" + }, + "trainExamplesCount": { + "description": "The number of examples labeled as TRAIN by Speech xps server.", + "format": "int32", + "type": "integer" + }, + "trainSentencesCount": { + "description": "The number of sentences in the training data set.", + "format": "int32", + "type": "integer" + }, + "trainWordsCount": { + "description": "The number of words in the training data set.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSStringStats": { + "description": "The data statistics of a series of STRING values.", + "id": "XPSStringStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "topUnigramStats": { + "description": "The statistics of the top 20 unigrams, ordered by StringStats.UnigramStats.count.", + "items": { + "$ref": "XPSStringStatsUnigramStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSStringStatsUnigramStats": { + "description": "The statistics of a unigram.", + "id": "XPSStringStatsUnigramStats", + "properties": { + "count": { + "description": "The number of occurrences of this unigram in the series.", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The unigram.", + "type": "string" + } + }, + "type": "object" + }, + "XPSStructStats": { + "description": "The data statistics of a series of STRUCT values.", + "id": "XPSStructStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "fieldStats": { + "additionalProperties": { + "$ref": "XPSDataStats" + }, + "description": "Map from a field name of the struct to data stats aggregated over series of all data in that field across all the structs.", + "type": "object" + } + }, + "type": "object" + }, + "XPSStructType": { + "description": "`StructType` defines the DataType-s of a STRUCT type.", + "id": "XPSStructType", + "properties": { + "fields": { + "additionalProperties": { + "$ref": "XPSDataType" + }, + "description": "Unordered map of struct field names to their data types.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTableSpec": { + "id": "XPSTableSpec", + "properties": { + "columnSpecs": { + "additionalProperties": { + "$ref": "XPSColumnSpec" + }, + "description": "Mapping from column id to column spec.", + "type": "object" + }, + "importedDataSizeInBytes": { + "description": "The total size of imported data of the table.", + "format": "int64", + "type": "string" + }, + "rowCount": { + "description": "The number of rows in the table.", + "format": "int64", + "type": "string" + }, + "timeColumnId": { + "description": "The id of the time column.", + "format": "int32", + "type": "integer" + }, + "validRowCount": { + "description": "The number of valid rows.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetrics": { + "description": "Metrics for Tables classification problems.", + "id": "XPSTablesClassificationMetrics", + "properties": { + "curveMetrics": { + "description": "Metrics building a curve.", + "items": { + "$ref": "XPSTablesClassificationMetricsCurveMetrics" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesClassificationMetricsCurveMetrics": { + "description": "Metrics curve data point for a single value.", + "id": "XPSTablesClassificationMetricsCurveMetrics", + "properties": { + "aucPr": { + "description": "The area under the precision-recall curve.", + "format": "double", + "type": "number" + }, + "aucRoc": { + "description": "The area under receiver operating characteristic curve.", + "format": "double", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Metrics that have confidence thresholds. Precision-recall curve and ROC curve can be derived from them.", + "items": { + "$ref": "XPSTablesConfidenceMetricsEntry" + }, + "type": "array" + }, + "logLoss": { + "description": "The Log loss metric.", + "format": "double", + "type": "number" + }, + "positionThreshold": { + "description": "The position threshold value used to compute the metrics.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The CATEGORY row value (for ARRAY unnested) the curve metrics are for.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSTablesConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "double", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision. (2 * precision * recall) / (precision + recall)", + "format": "double", + "type": "number" + }, + "falseNegativeCount": { + "description": "False negative count.", + "format": "int64", + "type": "string" + }, + "falsePositiveCount": { + "description": "False positive count.", + "format": "int64", + "type": "string" + }, + "falsePositiveRate": { + "description": "FPR = #false positives / (#false positives + #true negatives)", + "format": "double", + "type": "number" + }, + "precision": { + "description": "Precision = #true positives / (#true positives + #false positives).", + "format": "double", + "type": "number" + }, + "recall": { + "description": "Recall = #true positives / (#true positives + #false negatives).", + "format": "double", + "type": "number" + }, + "trueNegativeCount": { + "description": "True negative count.", + "format": "int64", + "type": "string" + }, + "truePositiveCount": { + "description": "True positive count.", + "format": "int64", + "type": "string" + }, + "truePositiveRate": { + "description": "TPR = #true positives / (#true positives + #false negatvies)", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesDatasetMetadata": { + "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "id": "XPSTablesDatasetMetadata", + "properties": { + "mlUseColumnId": { + "description": "Id the column to split the table.", + "format": "int32", + "type": "integer" + }, + "primaryTableSpec": { + "$ref": "XPSTableSpec", + "description": "Primary table." + }, + "targetColumnCorrelations": { + "additionalProperties": { + "$ref": "XPSCorrelationStats" + }, + "description": "(the column id : its CorrelationStats with target column).", + "type": "object" + }, + "targetColumnId": { + "description": "Id of the primary table column that should be used as the training label.", + "format": "int32", + "type": "integer" + }, + "weightColumnId": { + "description": "Id of the primary table column that should be used as the weight column.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "XPSTablesEvaluationMetrics": { + "id": "XPSTablesEvaluationMetrics", + "properties": { + "classificationMetrics": { + "$ref": "XPSTablesClassificationMetrics", + "description": "Classification metrics." + }, + "regressionMetrics": { + "$ref": "XPSTablesRegressionMetrics", + "description": "Regression metrics." + } + }, + "type": "object" + }, + "XPSTablesModelColumnInfo": { + "description": "An information specific to given column and Tables Model, in context of the Model and the predictions created by it.", + "id": "XPSTablesModelColumnInfo", + "properties": { + "columnId": { + "description": "The ID of the column.", + "format": "int32", + "type": "integer" + }, + "featureImportance": { + "description": "When given as part of a Model: Measurement of how much model predictions correctness on the TEST data depend on values in this column. A value between 0 and 1, higher means higher influence. These values are normalized - for all input feature columns of a given model they add to 1. When given back by Predict or Batch Predict: Measurement of how impactful for the prediction returned for the given row the value in this column was. Specifically, the feature importance specifies the marginal contribution that the feature made to the prediction score compared to the baseline score. These values are computed using the Sampled Shapley method.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesModelStructure": { + "description": "A description of Tables model structure.", + "id": "XPSTablesModelStructure", + "properties": { + "modelParameters": { + "description": "A list of models.", + "items": { + "$ref": "XPSTablesModelStructureModelParameters" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParameters": { + "description": "Model hyper-parameters for a model.", + "id": "XPSTablesModelStructureModelParameters", + "properties": { + "hyperparameters": { + "items": { + "$ref": "XPSTablesModelStructureModelParametersParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTablesModelStructureModelParametersParameter": { + "id": "XPSTablesModelStructureModelParametersParameter", + "properties": { + "floatValue": { + "description": "Float type parameter value.", + "format": "double", + "type": "number" + }, + "intValue": { + "description": "Integer type parameter value.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Parameter name.", + "type": "string" + }, + "stringValue": { + "description": "String type parameter value.", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesPreprocessResponse": { + "id": "XPSTablesPreprocessResponse", + "properties": { + "tablesDatasetMetadata": { + "$ref": "XPSTablesDatasetMetadata", + "description": "The table/column id, column_name and the DataTypes of the columns will be populated." + } + }, + "type": "object" + }, + "XPSTablesRegressionMetrics": { + "description": "Metrics for Tables regression problems.", + "id": "XPSTablesRegressionMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean absolute error.", + "format": "double", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error, only set if all of the target column's values are positive.", + "format": "double", + "type": "number" + }, + "rSquared": { + "description": "R squared.", + "format": "double", + "type": "number" + }, + "regressionMetricsEntries": { + "description": "A list of actual versus predicted points for the model being evaluated.", + "items": { + "$ref": "XPSRegressionMetricsEntry" + }, + "type": "array" + }, + "rootMeanSquaredError": { + "description": "Root mean squared error.", + "format": "double", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTablesTrainResponse": { + "id": "XPSTablesTrainResponse", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure" + }, + "predictionSampleRows": { + "description": "Sample rows from the dataset this model was trained.", + "items": { + "$ref": "XPSRow" + }, + "type": "array" + }, + "tablesModelColumnInfo": { + "description": "Output only. Auxiliary information for each of the input_feature_column_specs, with respect to this particular model.", + "items": { + "$ref": "XPSTablesModelColumnInfo" + }, + "type": "array" + }, + "trainCostMilliNodeHours": { + "description": "The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTablesTrainingOperationMetadata": { + "id": "XPSTablesTrainingOperationMetadata", + "properties": { + "createModelStage": { + "description": "Current stage of creating model.", + "enum": [ + "CREATE_MODEL_STAGE_UNSPECIFIED", + "DATA_PREPROCESSING", + "TRAINING", + "EVALUATING", + "MODEL_POST_PROCESSING" + ], + "enumDescriptions": [ + "Unspecified stage.", + "Prepare the model training pipeline and run data processing.", + "Training model.", + "Run evaluation.", + "Finalizing model training pipeline." + ], + "type": "string" + }, + "optimizationObjective": { + "description": "The optimization objective for model.", + "type": "string" + }, + "topTrials": { + "description": "This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure.", + "items": { + "$ref": "XPSTuningTrial" + }, + "type": "array" + }, + "trainBudgetMilliNodeHours": { + "description": "Creating model budget.", + "format": "int64", + "type": "string" + }, + "trainingObjectivePoints": { + "description": "This field records the training objective value with respect to time, giving insight into how the model architecture search is performing as training time elapses.", + "items": { + "$ref": "XPSTrainingObjectivePoint" + }, + "type": "array" + }, + "trainingStartTime": { + "description": "Timestamp when training process starts.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextComponentModel": { + "description": "Component model. Next ID: 10", + "id": "XPSTextComponentModel", + "properties": { + "batchPredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold batch prediction model.", + "type": "string" + }, + "onlinePredictionModelGcsUri": { + "description": "The Cloud Storage resource path to hold online prediction model.", + "type": "string" + }, + "partition": { + "description": "The partition where the model is deployed. Populated by uCAIP BE as part of online PredictRequest.", + "enum": [ + "PARTITION_TYPE_UNSPECIFIED", + "PARTITION_ZERO", + "PARTITION_REDUCED_HOMING", + "PARTITION_JELLYFISH", + "PARTITION_CPU", + "PARTITION_CUSTOM_STORAGE_CPU" + ], + "enumDescriptions": [ + "", + "The default partition.", + "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", + "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "The partition used by regionalized servomatic cloud regions.", + "The partition used for loading models from custom storage." + ], + "type": "string" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud Ai Platform API." + }, + "servoModelName": { + "description": "The name of servo model. Populated by uCAIP BE as part of online PredictRequest.", + "type": "string" + }, + "submodelName": { + "description": "The name of the trained NL submodel.", + "type": "string" + }, + "submodelType": { + "description": "The type of trained NL submodel", + "enum": [ + "TEXT_MODEL_TYPE_UNSPECIFIED", + "TEXT_MODEL_TYPE_DEFAULT", + "TEXT_MODEL_TYPE_META_ARCHITECT", + "TEXT_MODEL_TYPE_ATC", + "TEXT_MODEL_TYPE_CLARA2", + "TEXT_MODEL_TYPE_CHATBASE", + "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING", + "TEXT_MODEL_TYPE_TEXT_EXTRACTION", + "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION", + "TEXT_MODEL_TYPE_COMPOSITE", + "TEXT_MODEL_TYPE_ALL_MODELS", + "TEXT_MODEL_TYPE_BERT", + "TEXT_MODEL_TYPE_ENC_PALM" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "Model type for entity extraction.", + "Model type for relationship extraction.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", + "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", + "Model type for EncPaLM." + ], + "type": "string" + }, + "tfRuntimeVersion": { + "description": "## The fields below are only populated under uCAIP request scope. https://cloud.google.com/ml-engine/docs/runtime-version-list", + "type": "string" + }, + "versionNumber": { + "description": "The servomatic model version number. Populated by uCAIP BE as part of online PredictRequest.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTextExtractionEvaluationMetrics": { + "id": "XPSTextExtractionEvaluationMetrics", + "properties": { + "bestF1ConfidenceMetrics": { + "$ref": "XPSConfidenceMetricsEntry", + "deprecated": true, + "description": "Values are at the highest F1 score on the precision-recall curve. Only confidence_threshold, recall, precision, and f1_score will be set." + }, + "confidenceMetricsEntries": { + "description": "If the enclosing EvaluationMetrics.label is empty, confidence_metrics_entries is an evaluation of the entire model across all labels. If the enclosing EvaluationMetrics.label is set, confidence_metrics_entries applies to that label.", + "items": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "type": "array" + }, + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Confusion matrix of the model, at the default confidence threshold (0.0). Only set for whole-model evaluation, not for evaluation per label." + }, + "perLabelConfidenceMetrics": { + "additionalProperties": { + "$ref": "XPSConfidenceMetricsEntry" + }, + "deprecated": true, + "description": "Only recall, precision, and f1_score will be set.", + "type": "object" + } + }, + "type": "object" + }, + "XPSTextSentimentEvaluationMetrics": { + "description": "Model evaluation metrics for text sentiment problems.", + "id": "XPSTextSentimentEvaluationMetrics", + "properties": { + "confusionMatrix": { + "$ref": "XPSConfusionMatrix", + "description": "Output only. Confusion matrix of the evaluation. Only set for the overall model evaluation, not for evaluation of a single annotation spec." + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "linearKappa": { + "description": "Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanAbsoluteError": { + "description": "Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "meanSquaredError": { + "description": "Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision.", + "format": "float", + "type": "number" + }, + "quadraticKappa": { + "description": "Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTextToSpeechTrainResponse": { + "description": "TextToSpeech train response", + "id": "XPSTextToSpeechTrainResponse", + "properties": {}, + "type": "object" + }, + "XPSTextTrainResponse": { + "id": "XPSTextTrainResponse", + "properties": { + "componentModel": { + "description": "Component submodels.", + "items": { + "$ref": "XPSTextComponentModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSTfJsFormat": { + "description": "A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.", + "id": "XPSTfJsFormat", + "properties": {}, + "type": "object" + }, + "XPSTfLiteFormat": { + "description": "LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite.", + "id": "XPSTfLiteFormat", + "properties": {}, + "type": "object" + }, + "XPSTfSavedModelFormat": { + "description": "A tensorflow model format in SavedModel format.", + "id": "XPSTfSavedModelFormat", + "properties": {}, + "type": "object" + }, + "XPSTimestampStats": { + "description": "The data statistics of a series of TIMESTAMP values.", + "id": "XPSTimestampStats", + "properties": { + "commonStats": { + "$ref": "XPSCommonStats" + }, + "granularStats": { + "additionalProperties": { + "$ref": "XPSTimestampStatsGranularStats" + }, + "description": "The string key is the pre-defined granularity. Currently supported: hour_of_day, day_of_week, month_of_year. Granularities finer that the granularity of timestamp data are not populated (e.g. if timestamps are at day granularity, then hour_of_day is not populated).", + "type": "object" + }, + "medianTimestampNanos": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTimestampStatsGranularStats": { + "description": "Stats split by a defined in context granularity.", + "id": "XPSTimestampStatsGranularStats", + "properties": { + "buckets": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map from granularity key to example count for that key. E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means May).", + "type": "object" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntry": { + "description": "Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6.", + "id": "XPSTrackMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Output only. Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them.", + "items": { + "$ref": "XPSTrackMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "iouThreshold": { + "description": "Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.", + "format": "float", + "type": "number" + }, + "meanBoundingBoxIou": { + "description": "Output only. The mean bounding box iou over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanMismatchRate": { + "description": "Output only. The mean mismatch rate over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "meanTrackingAveragePrecision": { + "description": "Output only. The mean average precision over all confidence thresholds.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrackMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold. Next tag: 6.", + "id": "XPSTrackMetricsEntryConfidenceMetricsEntry", + "properties": { + "boundingBoxIou": { + "description": "Output only. Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold).", + "format": "float", + "type": "number" + }, + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "mismatchRate": { + "description": "Output only. Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", + "format": "float", + "type": "number" + }, + "trackingPrecision": { + "description": "Output only. Tracking precision.", + "format": "float", + "type": "number" + }, + "trackingRecall": { + "description": "Output only. Tracking recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTrainResponse": { + "description": "Next ID: 18", + "id": "XPSTrainResponse", + "properties": { + "deployedModelSizeBytes": { + "description": "Estimated model size in bytes once deployed.", + "format": "int64", + "type": "string" + }, + "errorAnalysisConfigs": { + "description": "Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample).", + "items": { + "$ref": "XPSVisionErrorAnalysisConfig" + }, + "type": "array" + }, + "evaluatedExampleSet": { + "$ref": "XPSExampleSet", + "description": "Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted." + }, + "evaluationMetricsSet": { + "$ref": "XPSEvaluationMetricsSet", + "description": "The trained model evaluation metrics. This can be optionally returned." + }, + "explanationConfigs": { + "deprecated": true, + "description": "VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request.", + "items": { + "$ref": "XPSResponseExplanationSpec" + }, + "type": "array" + }, + "imageClassificationTrainResp": { + "$ref": "XPSImageClassificationTrainResponse" + }, + "imageObjectDetectionTrainResp": { + "$ref": "XPSImageObjectDetectionModelSpec" + }, + "imageSegmentationTrainResp": { + "$ref": "XPSImageSegmentationTrainResponse" + }, + "modelToken": { + "description": "Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.", + "format": "byte", + "type": "string" + }, + "speechTrainResp": { + "$ref": "XPSSpeechModelSpec" + }, + "tablesTrainResp": { + "$ref": "XPSTablesTrainResponse" + }, + "textToSpeechTrainResp": { + "$ref": "XPSTextToSpeechTrainResponse" + }, + "textTrainResp": { + "$ref": "XPSTextTrainResponse", + "description": "Will only be needed for uCAIP from Beta." + }, + "translationTrainResp": { + "$ref": "XPSTranslationTrainResponse" + }, + "videoActionRecognitionTrainResp": { + "$ref": "XPSVideoActionRecognitionTrainResponse" + }, + "videoClassificationTrainResp": { + "$ref": "XPSVideoClassificationTrainResponse" + }, + "videoObjectTrackingTrainResp": { + "$ref": "XPSVideoObjectTrackingTrainResponse" + } + }, + "type": "object" + }, + "XPSTrainingObjectivePoint": { + "id": "XPSTrainingObjectivePoint", + "properties": { + "createTime": { + "description": "The time at which this point was recorded.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "The objective value when this point was recorded.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationEvaluationMetrics": { + "description": "Evaluation metrics for the dataset.", + "id": "XPSTranslationEvaluationMetrics", + "properties": { + "baseBleuScore": { + "description": "BLEU score for base model.", + "format": "double", + "type": "number" + }, + "bleuScore": { + "description": "BLEU score.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "XPSTranslationPreprocessResponse": { + "description": "Translation preprocess response.", + "id": "XPSTranslationPreprocessResponse", + "properties": { + "parsedExampleCount": { + "description": "Total example count parsed.", + "format": "int64", + "type": "string" + }, + "validExampleCount": { + "description": "Total valid example count.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSTranslationTrainResponse": { + "description": "Train response for translation.", + "id": "XPSTranslationTrainResponse", + "properties": { + "modelType": { + "description": "Type of the model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "LEGACY", + "CURRENT" + ], + "enumDescriptions": [ + "Default", + "Legacy model. Will be deprecated.", + "Current model." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSTuningTrial": { + "description": "Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users.", + "id": "XPSTuningTrial", + "properties": { + "modelStructure": { + "$ref": "XPSTablesModelStructure", + "description": "Model parameters for the trial." + }, + "trainingObjectivePoint": { + "$ref": "XPSTrainingObjectivePoint", + "description": "The optimization objective evaluation of the eval split data." + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntry": { + "description": "The Evaluation metrics entry given a specific precision_window_length.", + "id": "XPSVideoActionMetricsEntry", + "properties": { + "confidenceMetricsEntries": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSVideoActionMetricsEntryConfidenceMetricsEntry" + }, + "type": "array" + }, + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + }, + "precisionWindowLength": { + "description": "This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoActionMetricsEntryConfidenceMetricsEntry": { + "description": "Metrics for a single confidence threshold.", + "id": "XPSVideoActionMetricsEntryConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall for the given confidence threshold.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionEvaluationMetrics": { + "description": "Model evaluation metrics for video action recognition.", + "id": "XPSVideoActionRecognitionEvaluationMetrics", + "properties": { + "evaluatedActionCount": { + "description": "Output only. The number of ground truth actions used to create this evaluation.", + "format": "int32", + "type": "integer" + }, + "videoActionMetricsEntries": { + "description": "Output only. The metric entries for precision window lengths: 1s,2s,3s,4s, 5s.", + "items": { + "$ref": "XPSVideoActionMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoActionRecognitionTrainResponse": { + "id": "XPSVideoActionRecognitionTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoBatchPredictOperationMetadata": { + "id": "XPSVideoBatchPredictOperationMetadata", + "properties": { + "outputExamples": { + "description": "All the partial batch prediction results that are completed at the moment. Output examples are sorted by completion time. The order will not be changed. Each output example should be the path of a single RecordIO file of AnnotatedExamples.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoClassificationTrainResponse": { + "id": "XPSVideoClassificationTrainResponse", + "properties": { + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoExportModelSpec": { + "description": "Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.", + "id": "XPSVideoExportModelSpec", + "properties": { + "exportModelOutputConfig": { + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "items": { + "$ref": "XPSExportModelOutputConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoModelArtifactSpec": { + "id": "XPSVideoModelArtifactSpec", + "properties": { + "exportArtifact": { + "description": "The model binary files in different formats for model export.", + "items": { + "$ref": "XPSModelArtifactItem" + }, + "type": "array" + }, + "servingArtifact": { + "$ref": "XPSModelArtifactItem", + "description": "The default model binary file used for serving (e.g. batch predict) via public Cloud AI Platform API." + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingEvaluationMetrics": { + "description": "Model evaluation metrics for ObjectTracking problems. Next tag: 10.", + "id": "XPSVideoObjectTrackingEvaluationMetrics", + "properties": { + "boundingBoxMeanAveragePrecision": { + "description": "Output only. The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries.", + "format": "float", + "type": "number" + }, + "boundingBoxMetricsEntries": { + "description": "Output only. The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSBoundingBoxMetricsEntry" + }, + "type": "array" + }, + "evaluatedBoundingboxCount": { + "description": "The number of bounding boxes used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedFrameCount": { + "description": "The number of video frames used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "evaluatedTrackCount": { + "description": "The number of tracks used for model evaluation.", + "format": "int32", + "type": "integer" + }, + "trackMeanAveragePrecision": { + "description": "Output only. The single metric for tracks accuracy evaluation: the mean_average_precision averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanBoundingBoxIou": { + "description": "Output only. The single metric for tracks bounding box iou evaluation: the mean_bounding_box_iou averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMeanMismatchRate": { + "description": "Output only. The single metric for tracking consistency evaluation: the mean_mismatch_rate averaged over all track_metrics_entries.", + "format": "float", + "type": "number" + }, + "trackMetricsEntries": { + "description": "Output only. The tracks match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", + "items": { + "$ref": "XPSTrackMetricsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "XPSVideoObjectTrackingTrainResponse": { + "id": "XPSVideoObjectTrackingTrainResponse", + "properties": { + "exportModelSpec": { + "$ref": "XPSVideoExportModelSpec", + "description": "Populated for AutoML request only." + }, + "modelArtifactSpec": { + "$ref": "XPSVideoModelArtifactSpec", + "description": "## The fields below are only populated under uCAIP request scope." + }, + "trainCostNodeSeconds": { + "description": "The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVideoTrainingOperationMetadata": { + "id": "XPSVideoTrainingOperationMetadata", + "properties": { + "trainCostMilliNodeHour": { + "description": "This is an estimation of the node hours necessary for training a model, expressed in milli node hours (i.e. 1,000 value in this field means 1 node hour). A node hour represents the time a virtual machine spends running your training job. The cost of one node running for one hour is a node hour.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionErrorAnalysisConfig": { + "description": "The vision model error analysis configuration. Next tag: 3", + "id": "XPSVisionErrorAnalysisConfig", + "properties": { + "exampleCount": { + "description": "The number of query examples in error analysis.", + "format": "int32", + "type": "integer" + }, + "queryType": { + "description": "The query type used in retrieval. The enum values are frozen in the foreseeable future.", + "enum": [ + "QUERY_TYPE_UNSPECIFIED", + "QUERY_TYPE_ALL_SIMILAR", + "QUERY_TYPE_SAME_CLASS_SIMILAR", + "QUERY_TYPE_SAME_CLASS_DISSIMILAR" + ], + "enumDescriptions": [ + "Unspecified query type for model error analysis.", + "Query similar samples across all classes in the dataset.", + "Query similar samples from the same class of the input sample.", + "Query dissimilar samples from the same class of the input sample." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSVisionTrainingOperationMetadata": { + "deprecated": true, + "id": "XPSVisionTrainingOperationMetadata", + "properties": { + "explanationUsage": { + "$ref": "InfraUsage", + "description": "Aggregated infra usage within certain time period, for billing report purpose if XAI is enable in training request." + } + }, + "type": "object" + }, + "XPSVisualization": { + "deprecated": true, + "description": "Visualization configurations for image explanation.", + "id": "XPSVisualization", + "properties": { + "clipPercentLowerbound": { + "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.", + "format": "float", + "type": "number" + }, + "clipPercentUpperbound": { + "description": "Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.", + "format": "float", + "type": "number" + }, + "colorMap": { + "description": "The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.", + "enum": [ + "COLOR_MAP_UNSPECIFIED", + "PINK_GREEN", + "VIRIDIS", + "RED", + "GREEN", + "RED_GREEN", + "PINK_WHITE_GREEN" + ], + "enumDescriptions": [ + "Should not be used.", + "Positive: green. Negative: pink.", + "Viridis color map: A perceptually uniform color mapping which is easier to see by those with colorblindness and progresses from yellow to green to blue. Positive: yellow. Negative: blue.", + "Positive: red. Negative: red.", + "Positive: green. Negative: green.", + "Positive: green. Negative: red.", + "PiYG palette." + ], + "type": "string" + }, + "overlayType": { + "description": "How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.", + "enum": [ + "OVERLAY_TYPE_UNSPECIFIED", + "NONE", + "ORIGINAL", + "GRAYSCALE", + "MASK_BLACK" + ], + "enumDescriptions": [ + "Default value. This is the same as NONE.", + "No overlay.", + "The attributions are shown on top of the original image.", + "The attributions are shown on top of grayscaled version of the original image.", + "The attributions are used as a mask to reveal predictive parts of the image and hide the un-predictive parts." + ], + "type": "string" + }, + "polarity": { + "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", + "enum": [ + "POLARITY_UNSPECIFIED", + "POSITIVE", + "NEGATIVE", + "BOTH" + ], + "enumDescriptions": [ + "Default value. This is the same as POSITIVE.", + "Highlights the pixels/outlines that were most influential to the model's prediction.", + "Setting polarity to negative highlights areas that does not lead to the models's current prediction.", + "Shows both positive and negative attributions." + ], + "type": "string" + }, + "type": { + "description": "Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXELS", + "OUTLINES" + ], + "enumDescriptions": [ + "Should not be used.", + "Shows which pixel contributed to the image prediction.", + "Shows which region contributed to the image prediction by outlining the region." + ], + "type": "string" + } + }, + "type": "object" + }, + "XPSXpsOperationMetadata": { + "id": "XPSXpsOperationMetadata", + "properties": { + "exampleCount": { + "description": "Optional. XPS server can opt to provide example count of the long running operation (e.g. training, data importing, batch prediction).", + "format": "int64", + "type": "string" + }, + "reportingMetrics": { + "$ref": "XPSReportingMetrics", + "description": "Metrics for the operation. By the time the operation is terminated (whether succeeded or failed) as returned from XPS, AutoML BE assumes the metrics are finalized. AutoML BE transparently posts the metrics to Chemist if it's not empty, regardless of the response content or error type. If user is supposed to be charged in case of cancellation/error, this field should be set. In the case where the type of LRO doesn't require any billing, this field should be left unset." + }, + "tablesTrainingOperationMetadata": { + "$ref": "XPSTablesTrainingOperationMetadata" + }, + "videoBatchPredictOperationMetadata": { + "$ref": "XPSVideoBatchPredictOperationMetadata" + }, + "videoTrainingOperationMetadata": { + "$ref": "XPSVideoTrainingOperationMetadata" + }, + "visionTrainingOperationMetadata": { + "$ref": "XPSVisionTrainingOperationMetadata" + } + }, + "type": "object" + }, + "XPSXraiAttribution": { + "deprecated": true, + "description": "An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE).", + "id": "XPSXraiAttribution", + "properties": { + "stepCount": { + "description": "The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/language/v2/language-gen.go b/language/v2/language-gen.go index 54b88ccd8a8..e3e350b8855 100644 --- a/language/v2/language-gen.go +++ b/language/v2/language-gen.go @@ -378,7 +378,7 @@ type AnnotateTextRequest struct { EncodingType string `json:"encodingType,omitempty"` // Features: Required. The enabled features. - Features *Features `json:"features,omitempty"` + Features *AnnotateTextRequestFeatures `json:"features,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with @@ -403,6 +403,45 @@ func (s *AnnotateTextRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AnnotateTextRequestFeatures: All available features. Setting each one +// to true will enable that specific analysis for the input. +type AnnotateTextRequestFeatures struct { + // ClassifyText: Optional. Classify the full document into categories. + ClassifyText bool `json:"classifyText,omitempty"` + + // ExtractDocumentSentiment: Optional. Extract document-level sentiment. + ExtractDocumentSentiment bool `json:"extractDocumentSentiment,omitempty"` + + // ExtractEntities: Optional. Extract entities. + ExtractEntities bool `json:"extractEntities,omitempty"` + + // ModerateText: Optional. Moderate the document for harmful and + // sensitive categories. + ModerateText bool `json:"moderateText,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ClassifyText") 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. "ClassifyText") 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 *AnnotateTextRequestFeatures) MarshalJSON() ([]byte, error) { + type NoMethod AnnotateTextRequestFeatures + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AnnotateTextResponse: The text annotations response message. type AnnotateTextResponse struct { // Categories: Categories identified in the input document. @@ -584,6 +623,385 @@ func (s *ClassifyTextResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Color: Represents a color in the RGBA color space. This +// representation is designed for simplicity of conversion to and from +// color representations in various languages over compactness. For +// example, the fields of this representation can be trivially provided +// to the constructor of `java.awt.Color` in Java; it can also be +// trivially provided to UIColor's `+colorWithRed:green:blue:alpha` +// method in iOS; and, with just a little work, it can be easily +// formatted into a CSS `rgba()` string in JavaScript. This reference +// page doesn't have information about the absolute color space that +// should be used to interpret the RGB value—for example, sRGB, Adobe +// RGB, DCI-P3, and BT.2020. By default, applications should assume the +// sRGB color space. When color equality needs to be decided, +// implementations, unless documented otherwise, treat two colors as +// equal if all their red, green, blue, and alpha values each differ by +// at most `1e-5`. Example (Java): import com.google.type.Color; // ... +// public static java.awt.Color fromProto(Color protocolor) { float +// alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : +// 1.0; return new java.awt.Color( protocolor.getRed(), +// protocolor.getGreen(), protocolor.getBlue(), alpha); } public static +// Color toProto(java.awt.Color color) { float red = (float) +// color.getRed(); float green = (float) color.getGreen(); float blue = +// (float) color.getBlue(); float denominator = 255.0; Color.Builder +// resultBuilder = Color .newBuilder() .setRed(red / denominator) +// .setGreen(green / denominator) .setBlue(blue / denominator); int +// alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( +// FloatValue .newBuilder() .setValue(((float) alpha) / denominator) +// .build()); } return resultBuilder.build(); } // ... Example (iOS / +// Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float +// red = [protocolor red]; float green = [protocolor green]; float blue +// = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; +// float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper +// value]; } return [UIColor colorWithRed:red green:green blue:blue +// alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, +// green, blue, alpha; if (![color getRed:&red green:&green blue:&blue +// alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; +// [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; +// if (alpha <= 0.9999) { [result +// setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; +// return result; } // ... Example (JavaScript): // ... var +// protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red +// || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = +// rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green +// = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); +// if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, +// blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams +// = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', +// alphaFrac, ')'].join(”); }; var rgbToCssColor = function(red, green, +// blue) { var rgbNumber = new Number((red << 16) | (green << 8) | +// blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - +// hexString.length; var resultBuilder = ['#']; for (var i = 0; i < +// missingZeros; i++) { resultBuilder.push('0'); } +// resultBuilder.push(hexString); return resultBuilder.join(”); }; // +// ... +type Color struct { + // Alpha: The fraction of this color that should be applied to the + // pixel. That is, the final pixel color is defined by the equation: + // `pixel color = alpha * (this color) + (1.0 - alpha) * (background + // color)` This means that a value of 1.0 corresponds to a solid color, + // whereas a value of 0.0 corresponds to a completely transparent color. + // This uses a wrapper message rather than a simple float scalar so that + // it is possible to distinguish between a default value and the value + // being unset. If omitted, this color object is rendered as a solid + // color (as if the alpha value had been explicitly given a value of + // 1.0). + Alpha float64 `json:"alpha,omitempty"` + + // Blue: The amount of blue in the color as a value in the interval [0, + // 1]. + Blue float64 `json:"blue,omitempty"` + + // Green: The amount of green in the color as a value in the interval + // [0, 1]. + Green float64 `json:"green,omitempty"` + + // Red: The amount of red in the color as a value in the interval [0, + // 1]. + Red float64 `json:"red,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Alpha") 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. "Alpha") 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 *Color) MarshalJSON() ([]byte, error) { + type NoMethod Color + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *Color) UnmarshalJSON(data []byte) error { + type NoMethod Color + var s1 struct { + Alpha gensupport.JSONFloat64 `json:"alpha"` + Blue gensupport.JSONFloat64 `json:"blue"` + Green gensupport.JSONFloat64 `json:"green"` + Red gensupport.JSONFloat64 `json:"red"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Alpha = float64(s1.Alpha) + s.Blue = float64(s1.Blue) + s.Green = float64(s1.Green) + s.Red = float64(s1.Red) + return nil +} + +// CpuMetric: Metric for billing reports. +type CpuMetric struct { + // CoreNumber: Required. Number of CPU cores. + CoreNumber int64 `json:"coreNumber,omitempty,string"` + + // CoreSec: Required. Total seconds of core usage, e.g. 4. + CoreSec int64 `json:"coreSec,omitempty,string"` + + // CpuType: Required. Type of cpu, e.g. N2. + // + // Possible values: + // "UNKNOWN_CPU_TYPE" + // "A2" - GPU-based machine, skip quota reporting. + // "A3" - GPU-based machine, skip quota reporting. + // "C2" - COMPUTE_OPTIMIZED + // "C2D" + // "CUSTOM" + // "E2" + // "G2" - GPU-based machine, skip quota reporting. + // "C3" + // "M2" - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + // "M1" - MEMORY_OPTIMIZED + // "N1" + // "N2_CUSTOM" + // "N2" + // "N2D" + CpuType string `json:"cpuType,omitempty"` + + // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. + // + // Possible values: + // "UNKNOWN_MACHINE_SPEC" + // "N1_STANDARD_2" + // "N1_STANDARD_4" + // "N1_STANDARD_8" + // "N1_STANDARD_16" + // "N1_STANDARD_32" + // "N1_STANDARD_64" + // "N1_STANDARD_96" + // "N1_HIGHMEM_2" + // "N1_HIGHMEM_4" + // "N1_HIGHMEM_8" + // "N1_HIGHMEM_16" + // "N1_HIGHMEM_32" + // "N1_HIGHMEM_64" + // "N1_HIGHMEM_96" + // "N1_HIGHCPU_2" + // "N1_HIGHCPU_4" + // "N1_HIGHCPU_8" + // "N1_HIGHCPU_16" + // "N1_HIGHCPU_32" + // "N1_HIGHCPU_64" + // "N1_HIGHCPU_96" + // "A2_HIGHGPU_1G" + // "A2_HIGHGPU_2G" + // "A2_HIGHGPU_4G" + // "A2_HIGHGPU_8G" + // "A2_MEGAGPU_16G" + // "A2_ULTRAGPU_1G" + // "A2_ULTRAGPU_2G" + // "A2_ULTRAGPU_4G" + // "A2_ULTRAGPU_8G" + // "A3_HIGHGPU_8G" + // "E2_STANDARD_2" + // "E2_STANDARD_4" + // "E2_STANDARD_8" + // "E2_STANDARD_16" + // "E2_STANDARD_32" + // "E2_HIGHMEM_2" + // "E2_HIGHMEM_4" + // "E2_HIGHMEM_8" + // "E2_HIGHMEM_16" + // "E2_HIGHCPU_2" + // "E2_HIGHCPU_4" + // "E2_HIGHCPU_8" + // "E2_HIGHCPU_16" + // "E2_HIGHCPU_32" + // "N2_STANDARD_2" + // "N2_STANDARD_4" + // "N2_STANDARD_8" + // "N2_STANDARD_16" + // "N2_STANDARD_32" + // "N2_STANDARD_48" + // "N2_STANDARD_64" + // "N2_STANDARD_80" + // "N2_STANDARD_96" + // "N2_STANDARD_128" + // "N2_HIGHMEM_2" + // "N2_HIGHMEM_4" + // "N2_HIGHMEM_8" + // "N2_HIGHMEM_16" + // "N2_HIGHMEM_32" + // "N2_HIGHMEM_48" + // "N2_HIGHMEM_64" + // "N2_HIGHMEM_80" + // "N2_HIGHMEM_96" + // "N2_HIGHMEM_128" + // "N2_HIGHCPU_2" + // "N2_HIGHCPU_4" + // "N2_HIGHCPU_8" + // "N2_HIGHCPU_16" + // "N2_HIGHCPU_32" + // "N2_HIGHCPU_48" + // "N2_HIGHCPU_64" + // "N2_HIGHCPU_80" + // "N2_HIGHCPU_96" + // "N2D_STANDARD_2" + // "N2D_STANDARD_4" + // "N2D_STANDARD_8" + // "N2D_STANDARD_16" + // "N2D_STANDARD_32" + // "N2D_STANDARD_48" + // "N2D_STANDARD_64" + // "N2D_STANDARD_80" + // "N2D_STANDARD_96" + // "N2D_STANDARD_128" + // "N2D_STANDARD_224" + // "N2D_HIGHMEM_2" + // "N2D_HIGHMEM_4" + // "N2D_HIGHMEM_8" + // "N2D_HIGHMEM_16" + // "N2D_HIGHMEM_32" + // "N2D_HIGHMEM_48" + // "N2D_HIGHMEM_64" + // "N2D_HIGHMEM_80" + // "N2D_HIGHMEM_96" + // "N2D_HIGHCPU_2" + // "N2D_HIGHCPU_4" + // "N2D_HIGHCPU_8" + // "N2D_HIGHCPU_16" + // "N2D_HIGHCPU_32" + // "N2D_HIGHCPU_48" + // "N2D_HIGHCPU_64" + // "N2D_HIGHCPU_80" + // "N2D_HIGHCPU_96" + // "N2D_HIGHCPU_128" + // "N2D_HIGHCPU_224" + // "C2_STANDARD_4" + // "C2_STANDARD_8" + // "C2_STANDARD_16" + // "C2_STANDARD_30" + // "C2_STANDARD_60" + // "C2D_STANDARD_2" + // "C2D_STANDARD_4" + // "C2D_STANDARD_8" + // "C2D_STANDARD_16" + // "C2D_STANDARD_32" + // "C2D_STANDARD_56" + // "C2D_STANDARD_112" + // "C2D_HIGHCPU_2" + // "C2D_HIGHCPU_4" + // "C2D_HIGHCPU_8" + // "C2D_HIGHCPU_16" + // "C2D_HIGHCPU_32" + // "C2D_HIGHCPU_56" + // "C2D_HIGHCPU_112" + // "C2D_HIGHMEM_2" + // "C2D_HIGHMEM_4" + // "C2D_HIGHMEM_8" + // "C2D_HIGHMEM_16" + // "C2D_HIGHMEM_32" + // "C2D_HIGHMEM_56" + // "C2D_HIGHMEM_112" + // "G2_STANDARD_4" + // "G2_STANDARD_8" + // "G2_STANDARD_12" + // "G2_STANDARD_16" + // "G2_STANDARD_24" + // "G2_STANDARD_32" + // "G2_STANDARD_48" + // "G2_STANDARD_96" + // "C3_STANDARD_4" + // "C3_STANDARD_8" + // "C3_STANDARD_22" + // "C3_STANDARD_44" + // "C3_STANDARD_88" + // "C3_STANDARD_176" + // "C3_HIGHCPU_4" + // "C3_HIGHCPU_8" + // "C3_HIGHCPU_22" + // "C3_HIGHCPU_44" + // "C3_HIGHCPU_88" + // "C3_HIGHCPU_176" + // "C3_HIGHMEM_4" + // "C3_HIGHMEM_8" + // "C3_HIGHMEM_22" + // "C3_HIGHMEM_44" + // "C3_HIGHMEM_88" + // "C3_HIGHMEM_176" + MachineSpec string `json:"machineSpec,omitempty"` + + // TrackingLabels: Billing tracking labels. They do not contain any user + // data but only the labels set by Vertex Core Infra itself. Tracking + // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ + // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + TrackingLabels map[string]string `json:"trackingLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CoreNumber") 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. "CoreNumber") 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 *CpuMetric) MarshalJSON() ([]byte, error) { + type NoMethod CpuMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type DiskMetric struct { + // DiskType: Required. Type of Disk, e.g. REGIONAL_SSD. + // + // Possible values: + // "UNKNOWN_DISK_TYPE" + // "REGIONAL_SSD" + // "REGIONAL_STORAGE" + // "PD_SSD" + // "PD_STANDARD" + // "STORAGE_SNAPSHOT" + DiskType string `json:"diskType,omitempty"` + + // GibSec: Required. Seconds of physical disk usage, e.g. 3600. + GibSec int64 `json:"gibSec,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DiskType") 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. "DiskType") 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 *DiskMetric) MarshalJSON() ([]byte, error) { + type NoMethod DiskMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Document: Represents the input to API methods. type Document struct { // Content: The content of the input in string format. Cloud audit @@ -779,23 +1197,236 @@ func (s *EntityMention) UnmarshalJSON(data []byte) error { return nil } -// Features: All available features. Setting each one to true will -// enable that specific analysis for the input. -type Features struct { - // ClassifyText: Optional. Classify the full document into categories. - ClassifyText bool `json:"classifyText,omitempty"` +type GpuMetric struct { + // GpuSec: Required. Seconds of GPU usage, e.g. 3600. + GpuSec int64 `json:"gpuSec,omitempty,string"` - // ExtractDocumentSentiment: Optional. Extract document-level sentiment. - ExtractDocumentSentiment bool `json:"extractDocumentSentiment,omitempty"` + // GpuType: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + // + // Possible values: + // "UNKNOWN_GPU_TYPE" + // "NVIDIA_TESLA_A100" + // "NVIDIA_A100_80GB" + // "NVIDIA_TESLA_K80" + // "NVIDIA_L4" + // "NVIDIA_TESLA_P100" + // "NVIDIA_TESLA_P4" + // "NVIDIA_TESLA_T4" + // "NVIDIA_TESLA_V100" + // "NVIDIA_H100_80GB" + GpuType string `json:"gpuType,omitempty"` + + // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. + // + // Possible values: + // "UNKNOWN_MACHINE_SPEC" + // "N1_STANDARD_2" + // "N1_STANDARD_4" + // "N1_STANDARD_8" + // "N1_STANDARD_16" + // "N1_STANDARD_32" + // "N1_STANDARD_64" + // "N1_STANDARD_96" + // "N1_HIGHMEM_2" + // "N1_HIGHMEM_4" + // "N1_HIGHMEM_8" + // "N1_HIGHMEM_16" + // "N1_HIGHMEM_32" + // "N1_HIGHMEM_64" + // "N1_HIGHMEM_96" + // "N1_HIGHCPU_2" + // "N1_HIGHCPU_4" + // "N1_HIGHCPU_8" + // "N1_HIGHCPU_16" + // "N1_HIGHCPU_32" + // "N1_HIGHCPU_64" + // "N1_HIGHCPU_96" + // "A2_HIGHGPU_1G" + // "A2_HIGHGPU_2G" + // "A2_HIGHGPU_4G" + // "A2_HIGHGPU_8G" + // "A2_MEGAGPU_16G" + // "A2_ULTRAGPU_1G" + // "A2_ULTRAGPU_2G" + // "A2_ULTRAGPU_4G" + // "A2_ULTRAGPU_8G" + // "A3_HIGHGPU_8G" + // "E2_STANDARD_2" + // "E2_STANDARD_4" + // "E2_STANDARD_8" + // "E2_STANDARD_16" + // "E2_STANDARD_32" + // "E2_HIGHMEM_2" + // "E2_HIGHMEM_4" + // "E2_HIGHMEM_8" + // "E2_HIGHMEM_16" + // "E2_HIGHCPU_2" + // "E2_HIGHCPU_4" + // "E2_HIGHCPU_8" + // "E2_HIGHCPU_16" + // "E2_HIGHCPU_32" + // "N2_STANDARD_2" + // "N2_STANDARD_4" + // "N2_STANDARD_8" + // "N2_STANDARD_16" + // "N2_STANDARD_32" + // "N2_STANDARD_48" + // "N2_STANDARD_64" + // "N2_STANDARD_80" + // "N2_STANDARD_96" + // "N2_STANDARD_128" + // "N2_HIGHMEM_2" + // "N2_HIGHMEM_4" + // "N2_HIGHMEM_8" + // "N2_HIGHMEM_16" + // "N2_HIGHMEM_32" + // "N2_HIGHMEM_48" + // "N2_HIGHMEM_64" + // "N2_HIGHMEM_80" + // "N2_HIGHMEM_96" + // "N2_HIGHMEM_128" + // "N2_HIGHCPU_2" + // "N2_HIGHCPU_4" + // "N2_HIGHCPU_8" + // "N2_HIGHCPU_16" + // "N2_HIGHCPU_32" + // "N2_HIGHCPU_48" + // "N2_HIGHCPU_64" + // "N2_HIGHCPU_80" + // "N2_HIGHCPU_96" + // "N2D_STANDARD_2" + // "N2D_STANDARD_4" + // "N2D_STANDARD_8" + // "N2D_STANDARD_16" + // "N2D_STANDARD_32" + // "N2D_STANDARD_48" + // "N2D_STANDARD_64" + // "N2D_STANDARD_80" + // "N2D_STANDARD_96" + // "N2D_STANDARD_128" + // "N2D_STANDARD_224" + // "N2D_HIGHMEM_2" + // "N2D_HIGHMEM_4" + // "N2D_HIGHMEM_8" + // "N2D_HIGHMEM_16" + // "N2D_HIGHMEM_32" + // "N2D_HIGHMEM_48" + // "N2D_HIGHMEM_64" + // "N2D_HIGHMEM_80" + // "N2D_HIGHMEM_96" + // "N2D_HIGHCPU_2" + // "N2D_HIGHCPU_4" + // "N2D_HIGHCPU_8" + // "N2D_HIGHCPU_16" + // "N2D_HIGHCPU_32" + // "N2D_HIGHCPU_48" + // "N2D_HIGHCPU_64" + // "N2D_HIGHCPU_80" + // "N2D_HIGHCPU_96" + // "N2D_HIGHCPU_128" + // "N2D_HIGHCPU_224" + // "C2_STANDARD_4" + // "C2_STANDARD_8" + // "C2_STANDARD_16" + // "C2_STANDARD_30" + // "C2_STANDARD_60" + // "C2D_STANDARD_2" + // "C2D_STANDARD_4" + // "C2D_STANDARD_8" + // "C2D_STANDARD_16" + // "C2D_STANDARD_32" + // "C2D_STANDARD_56" + // "C2D_STANDARD_112" + // "C2D_HIGHCPU_2" + // "C2D_HIGHCPU_4" + // "C2D_HIGHCPU_8" + // "C2D_HIGHCPU_16" + // "C2D_HIGHCPU_32" + // "C2D_HIGHCPU_56" + // "C2D_HIGHCPU_112" + // "C2D_HIGHMEM_2" + // "C2D_HIGHMEM_4" + // "C2D_HIGHMEM_8" + // "C2D_HIGHMEM_16" + // "C2D_HIGHMEM_32" + // "C2D_HIGHMEM_56" + // "C2D_HIGHMEM_112" + // "G2_STANDARD_4" + // "G2_STANDARD_8" + // "G2_STANDARD_12" + // "G2_STANDARD_16" + // "G2_STANDARD_24" + // "G2_STANDARD_32" + // "G2_STANDARD_48" + // "G2_STANDARD_96" + // "C3_STANDARD_4" + // "C3_STANDARD_8" + // "C3_STANDARD_22" + // "C3_STANDARD_44" + // "C3_STANDARD_88" + // "C3_STANDARD_176" + // "C3_HIGHCPU_4" + // "C3_HIGHCPU_8" + // "C3_HIGHCPU_22" + // "C3_HIGHCPU_44" + // "C3_HIGHCPU_88" + // "C3_HIGHCPU_176" + // "C3_HIGHMEM_4" + // "C3_HIGHMEM_8" + // "C3_HIGHMEM_22" + // "C3_HIGHMEM_44" + // "C3_HIGHMEM_88" + // "C3_HIGHMEM_176" + MachineSpec string `json:"machineSpec,omitempty"` + + // TrackingLabels: Billing tracking labels. They do not contain any user + // data but only the labels set by Vertex Core Infra itself. Tracking + // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ + // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + TrackingLabels map[string]string `json:"trackingLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GpuSec") 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:"-"` - // ExtractEntities: Optional. Extract entities. - ExtractEntities bool `json:"extractEntities,omitempty"` + // NullFields is a list of field names (e.g. "GpuSec") 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:"-"` +} - // ModerateText: Optional. Moderate the document for harmful and - // sensitive categories. - ModerateText bool `json:"moderateText,omitempty"` +func (s *GpuMetric) MarshalJSON() ([]byte, error) { + type NoMethod GpuMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} - // ForceSendFields is a list of field names (e.g. "ClassifyText") to +// InfraUsage: Infra Usage of billing metrics. Next ID: 6 +type InfraUsage struct { + // CpuMetrics: Aggregated core metrics since requested start_time. + CpuMetrics []*CpuMetric `json:"cpuMetrics,omitempty"` + + // DiskMetrics: Aggregated persistent disk metrics since requested + // start_time. + DiskMetrics []*DiskMetric `json:"diskMetrics,omitempty"` + + // GpuMetrics: Aggregated gpu metrics since requested start_time. + GpuMetrics []*GpuMetric `json:"gpuMetrics,omitempty"` + + // RamMetrics: Aggregated ram metrics since requested start_time. + RamMetrics []*RamMetric `json:"ramMetrics,omitempty"` + + // TpuMetrics: Aggregated tpu metrics since requested start_time. + TpuMetrics []*TpuMetric `json:"tpuMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CpuMetrics") 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 @@ -803,17 +1434,17 @@ type Features struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ClassifyText") 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. "CpuMetrics") 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 *Features) MarshalJSON() ([]byte, error) { - type NoMethod Features +func (s *InfraUsage) MarshalJSON() ([]byte, error) { + type NoMethod InfraUsage raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } @@ -890,6 +1521,240 @@ func (s *ModerateTextResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type RamMetric struct { + // GibSec: Required. VM memory in Gigabyte second, e.g. 3600. Using + // int64 type to match billing metrics definition. + GibSec int64 `json:"gibSec,omitempty,string"` + + // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. + // + // Possible values: + // "UNKNOWN_MACHINE_SPEC" + // "N1_STANDARD_2" + // "N1_STANDARD_4" + // "N1_STANDARD_8" + // "N1_STANDARD_16" + // "N1_STANDARD_32" + // "N1_STANDARD_64" + // "N1_STANDARD_96" + // "N1_HIGHMEM_2" + // "N1_HIGHMEM_4" + // "N1_HIGHMEM_8" + // "N1_HIGHMEM_16" + // "N1_HIGHMEM_32" + // "N1_HIGHMEM_64" + // "N1_HIGHMEM_96" + // "N1_HIGHCPU_2" + // "N1_HIGHCPU_4" + // "N1_HIGHCPU_8" + // "N1_HIGHCPU_16" + // "N1_HIGHCPU_32" + // "N1_HIGHCPU_64" + // "N1_HIGHCPU_96" + // "A2_HIGHGPU_1G" + // "A2_HIGHGPU_2G" + // "A2_HIGHGPU_4G" + // "A2_HIGHGPU_8G" + // "A2_MEGAGPU_16G" + // "A2_ULTRAGPU_1G" + // "A2_ULTRAGPU_2G" + // "A2_ULTRAGPU_4G" + // "A2_ULTRAGPU_8G" + // "A3_HIGHGPU_8G" + // "E2_STANDARD_2" + // "E2_STANDARD_4" + // "E2_STANDARD_8" + // "E2_STANDARD_16" + // "E2_STANDARD_32" + // "E2_HIGHMEM_2" + // "E2_HIGHMEM_4" + // "E2_HIGHMEM_8" + // "E2_HIGHMEM_16" + // "E2_HIGHCPU_2" + // "E2_HIGHCPU_4" + // "E2_HIGHCPU_8" + // "E2_HIGHCPU_16" + // "E2_HIGHCPU_32" + // "N2_STANDARD_2" + // "N2_STANDARD_4" + // "N2_STANDARD_8" + // "N2_STANDARD_16" + // "N2_STANDARD_32" + // "N2_STANDARD_48" + // "N2_STANDARD_64" + // "N2_STANDARD_80" + // "N2_STANDARD_96" + // "N2_STANDARD_128" + // "N2_HIGHMEM_2" + // "N2_HIGHMEM_4" + // "N2_HIGHMEM_8" + // "N2_HIGHMEM_16" + // "N2_HIGHMEM_32" + // "N2_HIGHMEM_48" + // "N2_HIGHMEM_64" + // "N2_HIGHMEM_80" + // "N2_HIGHMEM_96" + // "N2_HIGHMEM_128" + // "N2_HIGHCPU_2" + // "N2_HIGHCPU_4" + // "N2_HIGHCPU_8" + // "N2_HIGHCPU_16" + // "N2_HIGHCPU_32" + // "N2_HIGHCPU_48" + // "N2_HIGHCPU_64" + // "N2_HIGHCPU_80" + // "N2_HIGHCPU_96" + // "N2D_STANDARD_2" + // "N2D_STANDARD_4" + // "N2D_STANDARD_8" + // "N2D_STANDARD_16" + // "N2D_STANDARD_32" + // "N2D_STANDARD_48" + // "N2D_STANDARD_64" + // "N2D_STANDARD_80" + // "N2D_STANDARD_96" + // "N2D_STANDARD_128" + // "N2D_STANDARD_224" + // "N2D_HIGHMEM_2" + // "N2D_HIGHMEM_4" + // "N2D_HIGHMEM_8" + // "N2D_HIGHMEM_16" + // "N2D_HIGHMEM_32" + // "N2D_HIGHMEM_48" + // "N2D_HIGHMEM_64" + // "N2D_HIGHMEM_80" + // "N2D_HIGHMEM_96" + // "N2D_HIGHCPU_2" + // "N2D_HIGHCPU_4" + // "N2D_HIGHCPU_8" + // "N2D_HIGHCPU_16" + // "N2D_HIGHCPU_32" + // "N2D_HIGHCPU_48" + // "N2D_HIGHCPU_64" + // "N2D_HIGHCPU_80" + // "N2D_HIGHCPU_96" + // "N2D_HIGHCPU_128" + // "N2D_HIGHCPU_224" + // "C2_STANDARD_4" + // "C2_STANDARD_8" + // "C2_STANDARD_16" + // "C2_STANDARD_30" + // "C2_STANDARD_60" + // "C2D_STANDARD_2" + // "C2D_STANDARD_4" + // "C2D_STANDARD_8" + // "C2D_STANDARD_16" + // "C2D_STANDARD_32" + // "C2D_STANDARD_56" + // "C2D_STANDARD_112" + // "C2D_HIGHCPU_2" + // "C2D_HIGHCPU_4" + // "C2D_HIGHCPU_8" + // "C2D_HIGHCPU_16" + // "C2D_HIGHCPU_32" + // "C2D_HIGHCPU_56" + // "C2D_HIGHCPU_112" + // "C2D_HIGHMEM_2" + // "C2D_HIGHMEM_4" + // "C2D_HIGHMEM_8" + // "C2D_HIGHMEM_16" + // "C2D_HIGHMEM_32" + // "C2D_HIGHMEM_56" + // "C2D_HIGHMEM_112" + // "G2_STANDARD_4" + // "G2_STANDARD_8" + // "G2_STANDARD_12" + // "G2_STANDARD_16" + // "G2_STANDARD_24" + // "G2_STANDARD_32" + // "G2_STANDARD_48" + // "G2_STANDARD_96" + // "C3_STANDARD_4" + // "C3_STANDARD_8" + // "C3_STANDARD_22" + // "C3_STANDARD_44" + // "C3_STANDARD_88" + // "C3_STANDARD_176" + // "C3_HIGHCPU_4" + // "C3_HIGHCPU_8" + // "C3_HIGHCPU_22" + // "C3_HIGHCPU_44" + // "C3_HIGHCPU_88" + // "C3_HIGHCPU_176" + // "C3_HIGHMEM_4" + // "C3_HIGHMEM_8" + // "C3_HIGHMEM_22" + // "C3_HIGHMEM_44" + // "C3_HIGHMEM_88" + // "C3_HIGHMEM_176" + MachineSpec string `json:"machineSpec,omitempty"` + + // Memories: Required. VM memory in gb. + Memories float64 `json:"memories,omitempty"` + + // RamType: Required. Type of ram. + // + // Possible values: + // "UNKNOWN_RAM_TYPE" + // "A2" + // "A3" + // "C2" - COMPUTE_OPTIMIZED + // "C2D" + // "CUSTOM" + // "E2" + // "G2" + // "C3" + // "M2" - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + // "M1" - MEMORY_OPTIMIZED + // "N1" + // "N2_CUSTOM" + // "N2" + // "N2D" + RamType string `json:"ramType,omitempty"` + + // TrackingLabels: Billing tracking labels. They do not contain any user + // data but only the labels set by Vertex Core Infra itself. Tracking + // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ + // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" + TrackingLabels map[string]string `json:"trackingLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GibSec") 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. "GibSec") 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 *RamMetric) MarshalJSON() ([]byte, error) { + type NoMethod RamMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *RamMetric) UnmarshalJSON(data []byte) error { + type NoMethod RamMetric + var s1 struct { + Memories gensupport.JSONFloat64 `json:"memories"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Memories = float64(s1.Memories) + return nil +} + // Sentence: Represents a sentence in the input document. type Sentence struct { // Sentiment: For calls to AnalyzeSentiment or if @@ -1052,6 +1917,5155 @@ func (s *TextSpan) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type TpuMetric struct { + // TpuSec: Required. Seconds of TPU usage, e.g. 3600. + TpuSec int64 `json:"tpuSec,omitempty,string"` + + // TpuType: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + // + // Possible values: + // "UNKNOWN_TPU_TYPE" + // "TPU_V2_POD" + // "TPU_V2" + // "TPU_V3_POD" + // "TPU_V3" + // "TPU_V5_LITEPOD" + TpuType string `json:"tpuType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "TpuSec") 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. "TpuSec") 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 *TpuMetric) MarshalJSON() ([]byte, error) { + type NoMethod TpuMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSArrayStats: The data statistics of a series of ARRAY values. +type XPSArrayStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // MemberStats: Stats of all the values of all arrays, as if they were a + // single long series of data. The type depends on the element type of + // the array. + MemberStats *XPSDataStats `json:"memberStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSArrayStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSArrayStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSBatchPredictResponse struct { + // ExampleSet: Examples for batch prediction result. Under full API + // implementation, results are stored in shared RecordIO of + // AnnotatedExample protobufs, the annotations field of which is + // populated by XPS backend. + ExampleSet *XPSExampleSet `json:"exampleSet,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExampleSet") 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. "ExampleSet") 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 *XPSBatchPredictResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSBatchPredictResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSBoundingBoxMetricsEntry: Bounding box matching model metrics for a +// single intersection-over-union threshold and multiple label match +// confidence thresholds. +type XPSBoundingBoxMetricsEntry struct { + // ConfidenceMetricsEntries: Metrics for each label-match + // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + ConfidenceMetricsEntries []*XPSBoundingBoxMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // IouThreshold: The intersection-over-union threshold value used to + // compute this metrics entry. + IouThreshold float64 `json:"iouThreshold,omitempty"` + + // MeanAveragePrecision: The mean average precision. + MeanAveragePrecision float64 `json:"meanAveragePrecision,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSBoundingBoxMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSBoundingBoxMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSBoundingBoxMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSBoundingBoxMetricsEntry + var s1 struct { + IouThreshold gensupport.JSONFloat64 `json:"iouThreshold"` + MeanAveragePrecision gensupport.JSONFloat64 `json:"meanAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.IouThreshold = float64(s1.IouThreshold) + s.MeanAveragePrecision = float64(s1.MeanAveragePrecision) + return nil +} + +// XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: Metrics for a +// single confidence threshold. +type XPSBoundingBoxMetricsEntryConfidenceMetricsEntry struct { + // ConfidenceThreshold: The confidence threshold value used to compute + // the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // Precision: Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // Recall: Recall for the given confidence threshold. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + return nil +} + +// XPSCategoryStats: The data statistics of a series of CATEGORY values. +type XPSCategoryStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // TopCategoryStats: The statistics of the top 20 CATEGORY values, + // ordered by CategoryStats.SingleCategoryStats.count. + TopCategoryStats []*XPSCategoryStatsSingleCategoryStats `json:"topCategoryStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSCategoryStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCategoryStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSCategoryStatsSingleCategoryStats: The statistics of a single +// CATEGORY value. +type XPSCategoryStatsSingleCategoryStats struct { + // Count: The number of occurrences of this value in the series. + Count int64 `json:"count,omitempty,string"` + + // Value: The CATEGORY value. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSCategoryStatsSingleCategoryStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCategoryStatsSingleCategoryStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSClassificationEvaluationMetrics: Model evaluation metrics for +// classification problems. It can be used for image and video +// classification. Next tag: 9. +type XPSClassificationEvaluationMetrics struct { + // AuPrc: The Area under precision recall curve metric. + AuPrc float64 `json:"auPrc,omitempty"` + + // AuRoc: The Area Under Receiver Operating Characteristic curve metric. + // Micro-averaged for the overall evaluation. + AuRoc float64 `json:"auRoc,omitempty"` + + // BaseAuPrc: The Area under precision recall curve metric based on + // priors. + BaseAuPrc float64 `json:"baseAuPrc,omitempty"` + + // ConfidenceMetricsEntries: Metrics that have confidence thresholds. + // Precision-recall curve can be derived from it. + ConfidenceMetricsEntries []*XPSConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // ConfusionMatrix: Confusion matrix of the evaluation. Only set for + // MULTICLASS classification problems where number of annotation specs + // is no more than 10. Only set for model level evaluation, not for + // evaluation per label. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // EvaluatedExamplesCount: The number of examples used for model + // evaluation. + EvaluatedExamplesCount int64 `json:"evaluatedExamplesCount,omitempty"` + + // LogLoss: The Log Loss metric. + LogLoss float64 `json:"logLoss,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AuPrc") 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. "AuPrc") 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 *XPSClassificationEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSClassificationEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSClassificationEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSClassificationEvaluationMetrics + var s1 struct { + AuPrc gensupport.JSONFloat64 `json:"auPrc"` + AuRoc gensupport.JSONFloat64 `json:"auRoc"` + BaseAuPrc gensupport.JSONFloat64 `json:"baseAuPrc"` + LogLoss gensupport.JSONFloat64 `json:"logLoss"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.AuPrc = float64(s1.AuPrc) + s.AuRoc = float64(s1.AuRoc) + s.BaseAuPrc = float64(s1.BaseAuPrc) + s.LogLoss = float64(s1.LogLoss) + return nil +} + +// XPSColorMap: Map from color to display name. Will only be used by +// Image Segmentation for uCAIP. +type XPSColorMap struct { + // AnnotationSpecIdToken: Should be used during training. + AnnotationSpecIdToken string `json:"annotationSpecIdToken,omitempty"` + + // Color: This type is deprecated in favor of the IntColor below. This + // is because google.type.Color represent color has a float which + // semantically does not reflect discrete classes/categories concept. + // Moreover, to handle it well we need to have some tolerance when + // converting to a discretized color. As such, the recommendation is to + // have API surface still use google.type.Color while internally + // IntColor is used. + Color *Color `json:"color,omitempty"` + + // DisplayName: Should be used during preprocessing. + DisplayName string `json:"displayName,omitempty"` + + IntColor *XPSColorMapIntColor `json:"intColor,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AnnotationSpecIdToken") 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. "AnnotationSpecIdToken") 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 *XPSColorMap) MarshalJSON() ([]byte, error) { + type NoMethod XPSColorMap + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSColorMapIntColor: RGB color and each channel is represented by an +// integer. +type XPSColorMapIntColor struct { + // Blue: The value should be in range of [0, 255]. + Blue int64 `json:"blue,omitempty"` + + // Green: The value should be in range of [0, 255]. + Green int64 `json:"green,omitempty"` + + // Red: The value should be in range of [0, 255]. + Red int64 `json:"red,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Blue") 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. "Blue") 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 *XPSColorMapIntColor) MarshalJSON() ([]byte, error) { + type NoMethod XPSColorMapIntColor + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSColumnSpec struct { + // ColumnId: The unique id of the column. When Preprocess, the Tables BE + // will popuate the order id of the column, which reflects the order of + // the column inside the table, i.e. 0 means the first column in the + // table, N-1 means the last column. AutoML BE will persist this order + // id in Spanner and set the order id here when calling + // RefreshTablesStats and Train. Note: it's different than the + // column_spec_id that is generated in AutoML BE. + ColumnId int64 `json:"columnId,omitempty"` + + // DataStats: The data stats of the column. It's outputed in + // RefreshTablesStats and a required input for Train. + DataStats *XPSDataStats `json:"dataStats,omitempty"` + + // DataType: The data type of the column. It's outputed in Preprocess + // rpc and a required input for RefreshTablesStats and Train. + DataType *XPSDataType `json:"dataType,omitempty"` + + // DisplayName: The display name of the column. It's outputed in + // Preprocess and a required input for RefreshTablesStats and Train. + DisplayName string `json:"displayName,omitempty"` + + ForecastingMetadata *XPSColumnSpecForecastingMetadata `json:"forecastingMetadata,omitempty"` + + // TopCorrelatedColumns: It's outputed in RefreshTablesStats, and a + // required input in Train. + TopCorrelatedColumns []*XPSColumnSpecCorrelatedColumn `json:"topCorrelatedColumns,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnId") 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. "ColumnId") 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 *XPSColumnSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSColumnSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSColumnSpecCorrelatedColumn: Identifies a table's column, and its +// correlation with the column this ColumnSpec describes. +type XPSColumnSpecCorrelatedColumn struct { + ColumnId int64 `json:"columnId,omitempty"` + + CorrelationStats *XPSCorrelationStats `json:"correlationStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnId") 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. "ColumnId") 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 *XPSColumnSpecCorrelatedColumn) MarshalJSON() ([]byte, error) { + type NoMethod XPSColumnSpecCorrelatedColumn + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSColumnSpecForecastingMetadata: +// ====================================================================== +// ===== # The fields below are used exclusively for Forecasting. +type XPSColumnSpecForecastingMetadata struct { + // ColumnType: The type of the column for FORECASTING model training + // purposes. + // + // Possible values: + // "COLUMN_TYPE_UNSPECIFIED" - An un-set value of this enum. + // "KEY" - Key columns are used to identify timeseries. + // "KEY_METADATA" - This column contains information describing static + // properties of the entities identified by the key column(s) (e.g. + // city's ZIP code). + // "TIME_SERIES_AVAILABLE_PAST_ONLY" - This column contains + // information for the given entity, at any time poinrt, they are only + // available in the time series before. + // "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" - This column contains + // information for the given entity is known both for the past and the + // sufficiently far future. + ColumnType string `json:"columnType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnType") 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. "ColumnType") 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 *XPSColumnSpecForecastingMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSColumnSpecForecastingMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSCommonStats: Common statistics for a column with a specified data +// type. +type XPSCommonStats struct { + DistinctValueCount int64 `json:"distinctValueCount,omitempty,string"` + + NullValueCount int64 `json:"nullValueCount,omitempty,string"` + + ValidValueCount int64 `json:"validValueCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DistinctValueCount") + // 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. "DistinctValueCount") 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 *XPSCommonStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCommonStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSConfidenceMetricsEntry: ConfidenceMetricsEntry includes generic +// precision, recall, f1 score etc. Next tag: 16. +type XPSConfidenceMetricsEntry struct { + // ConfidenceThreshold: Metrics are computed with an assumption that the + // model never return predictions with score lower than this value. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // F1ScoreAt1: The harmonic mean of recall_at1 and precision_at1. + F1ScoreAt1 float64 `json:"f1ScoreAt1,omitempty"` + + // FalseNegativeCount: The number of ground truth labels that are not + // matched by a model created label. + FalseNegativeCount int64 `json:"falseNegativeCount,omitempty,string"` + + // FalsePositiveCount: The number of model created labels that do not + // match a ground truth label. + FalsePositiveCount int64 `json:"falsePositiveCount,omitempty,string"` + + // FalsePositiveRate: False Positive Rate for the given confidence + // threshold. + FalsePositiveRate float64 `json:"falsePositiveRate,omitempty"` + + // FalsePositiveRateAt1: The False Positive Rate when only considering + // the label that has the highest prediction score and not below the + // confidence threshold for each example. + FalsePositiveRateAt1 float64 `json:"falsePositiveRateAt1,omitempty"` + + // PositionThreshold: Metrics are computed with an assumption that the + // model always returns at most this many predictions (ordered by their + // score, descendingly), but they all still need to meet the + // confidence_threshold. + PositionThreshold int64 `json:"positionThreshold,omitempty"` + + // Precision: Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // PrecisionAt1: The precision when only considering the label that has + // the highest prediction score and not below the confidence threshold + // for each example. + PrecisionAt1 float64 `json:"precisionAt1,omitempty"` + + // Recall: Recall (true positive rate) for the given confidence + // threshold. + Recall float64 `json:"recall,omitempty"` + + // RecallAt1: The recall (true positive rate) when only considering the + // label that has the highest prediction score and not below the + // confidence threshold for each example. + RecallAt1 float64 `json:"recallAt1,omitempty"` + + // TrueNegativeCount: The number of labels that were not created by the + // model, but if they would, they would not match a ground truth label. + TrueNegativeCount int64 `json:"trueNegativeCount,omitempty,string"` + + // TruePositiveCount: The number of model created labels that match a + // ground truth label. + TruePositiveCount int64 `json:"truePositiveCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + F1ScoreAt1 gensupport.JSONFloat64 `json:"f1ScoreAt1"` + FalsePositiveRate gensupport.JSONFloat64 `json:"falsePositiveRate"` + FalsePositiveRateAt1 gensupport.JSONFloat64 `json:"falsePositiveRateAt1"` + Precision gensupport.JSONFloat64 `json:"precision"` + PrecisionAt1 gensupport.JSONFloat64 `json:"precisionAt1"` + Recall gensupport.JSONFloat64 `json:"recall"` + RecallAt1 gensupport.JSONFloat64 `json:"recallAt1"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.F1ScoreAt1 = float64(s1.F1ScoreAt1) + s.FalsePositiveRate = float64(s1.FalsePositiveRate) + s.FalsePositiveRateAt1 = float64(s1.FalsePositiveRateAt1) + s.Precision = float64(s1.Precision) + s.PrecisionAt1 = float64(s1.PrecisionAt1) + s.Recall = float64(s1.Recall) + s.RecallAt1 = float64(s1.RecallAt1) + return nil +} + +// XPSConfusionMatrix: Confusion matrix of the model running the +// classification. +type XPSConfusionMatrix struct { + // AnnotationSpecIdToken: For the following three repeated fields, only + // one is intended to be set. annotation_spec_id_token is preferable to + // be set. ID tokens of the annotation specs used in the confusion + // matrix. + AnnotationSpecIdToken []string `json:"annotationSpecIdToken,omitempty"` + + // Category: Category (mainly for segmentation). Set only for image + // segmentation models. Note: uCAIP Image Segmentation should use + // annotation_spec_id_token. + Category []int64 `json:"category,omitempty"` + + // Row: Rows in the confusion matrix. The number of rows is equal to the + // size of `annotation_spec_id_token`. `row[i].value[j]` is the number + // of examples that have ground truth of the + // `annotation_spec_id_token[i]` and are predicted as + // `annotation_spec_id_token[j]` by the model being evaluated. + Row []*XPSConfusionMatrixRow `json:"row,omitempty"` + + // SentimentLabel: Sentiment labels used in the confusion matrix. Set + // only for text sentiment models. For AutoML Text Revamp, use + // `annotation_spec_id_token` instead and leave this field empty. + SentimentLabel []int64 `json:"sentimentLabel,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AnnotationSpecIdToken") 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. "AnnotationSpecIdToken") 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 *XPSConfusionMatrix) MarshalJSON() ([]byte, error) { + type NoMethod XPSConfusionMatrix + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSConfusionMatrixRow: A row in the confusion matrix. +type XPSConfusionMatrixRow struct { + // Count: Same as above except intended to represent other counts (for + // e.g. for segmentation this is pixel count). NOTE(params): Only + // example_count or count is set (oneoff does not support repeated + // fields unless they are embedded inside another message). + Count googleapi.Int64s `json:"count,omitempty"` + + // ExampleCount: Value of the specific cell in the confusion matrix. The + // number of values each row has (i.e. the length of the row) is equal + // to the length of the annotation_spec_id_token field. + ExampleCount []int64 `json:"exampleCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSConfusionMatrixRow) MarshalJSON() ([]byte, error) { + type NoMethod XPSConfusionMatrixRow + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSCoreMlFormat: A model format used for iOS mobile devices. +type XPSCoreMlFormat struct { +} + +// XPSCorrelationStats: A correlation statistics between two series of +// DataType values. The series may have differing DataType-s, but within +// a single series the DataType must be the same. +type XPSCorrelationStats struct { + // CramersV: The correlation value using the Cramer's V measure. + CramersV float64 `json:"cramersV,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CramersV") 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. "CramersV") 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 *XPSCorrelationStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSCorrelationStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSCorrelationStats) UnmarshalJSON(data []byte) error { + type NoMethod XPSCorrelationStats + var s1 struct { + CramersV gensupport.JSONFloat64 `json:"cramersV"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.CramersV = float64(s1.CramersV) + return nil +} + +// XPSDataErrors: Different types of errors and the stats associatesd +// with each error. +type XPSDataErrors struct { + // Count: Number of records having errors associated with the enum. + Count int64 `json:"count,omitempty"` + + // ErrorType: Type of the error. + // + // Possible values: + // "ERROR_TYPE_UNSPECIFIED" - Not specified. + // "UNSUPPORTED_AUDIO_FORMAT" - Audio format not in the formats by + // cloud-speech AutoML. Currently only wav and flac file formats are + // supported. + // "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT" - File format differnt + // from what is specified in the file name extension. + // "FILE_TOO_LARGE" - File too large. Maximum allowed size is 50 MB. + // "MISSING_TRANSCRIPTION" - Transcript is missing. + ErrorType string `json:"errorType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSDataErrors) MarshalJSON() ([]byte, error) { + type NoMethod XPSDataErrors + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSDataStats: The data statistics of a series of values that share +// the same DataType. +type XPSDataStats struct { + // ArrayStats: The statistics for ARRAY DataType. + ArrayStats *XPSArrayStats `json:"arrayStats,omitempty"` + + // CategoryStats: The statistics for CATEGORY DataType. + CategoryStats *XPSCategoryStats `json:"categoryStats,omitempty"` + + // DistinctValueCount: The number of distinct values. + DistinctValueCount int64 `json:"distinctValueCount,omitempty,string"` + + // Float64Stats: The statistics for FLOAT64 DataType. + Float64Stats *XPSFloat64Stats `json:"float64Stats,omitempty"` + + // NullValueCount: The number of values that are null. + NullValueCount int64 `json:"nullValueCount,omitempty,string"` + + // StringStats: The statistics for STRING DataType. + StringStats *XPSStringStats `json:"stringStats,omitempty"` + + // StructStats: The statistics for STRUCT DataType. + StructStats *XPSStructStats `json:"structStats,omitempty"` + + // TimestampStats: The statistics for TIMESTAMP DataType. + TimestampStats *XPSTimestampStats `json:"timestampStats,omitempty"` + + // ValidValueCount: The number of values that are valid. + ValidValueCount int64 `json:"validValueCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ArrayStats") 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. "ArrayStats") 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 *XPSDataStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSDataStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSDataType: Indicated the type of data that can be stored in a +// structured data entity (e.g. a table). +type XPSDataType struct { + // CompatibleDataTypes: The highly compatible data types to this data + // type. + CompatibleDataTypes []*XPSDataType `json:"compatibleDataTypes,omitempty"` + + // ListElementType: If type_code == ARRAY, then `list_element_type` is + // the type of the elements. + ListElementType *XPSDataType `json:"listElementType,omitempty"` + + // Nullable: If true, this DataType can also be `null`. + Nullable bool `json:"nullable,omitempty"` + + // StructType: If type_code == STRUCT, then `struct_type` provides type + // information for the struct's fields. + StructType *XPSStructType `json:"structType,omitempty"` + + // TimeFormat: If type_code == TIMESTAMP then `time_format` provides the + // format in which that time field is expressed. The time_format must be + // written in `strftime` syntax. If time_format is not set, then the + // default format as described on the field is used. + TimeFormat string `json:"timeFormat,omitempty"` + + // TypeCode: Required. The TypeCode for this type. + // + // Possible values: + // "TYPE_CODE_UNSPECIFIED" - Not specified. Should not be used. + // "FLOAT64" - Encoded as `number`, or the strings "NaN", + // "Infinity", or "-Infinity". + // "TIMESTAMP" - Must be between 0AD and 9999AD. Encoded as `string` + // according to time_format, or, if that format is not set, then in RFC + // 3339 `date-time` format, where `time-offset` = "Z" (e.g. + // 1985-04-12T23:20:50.52Z). + // "STRING" - Encoded as `string`. + // "ARRAY" - Encoded as `list`, where the list elements are + // represented according to list_element_type. + // "STRUCT" - Encoded as `struct`, where field values are represented + // according to struct_type. + // "CATEGORY" - Values of this type are not further understood by + // AutoML, e.g. AutoML is unable to tell the order of values (as it + // could with FLOAT64), or is unable to say if one value contains + // another (as it could with STRING). Encoded as `string` (bytes should + // be base64-encoded, as described in RFC 4648, section 4). + TypeCode string `json:"typeCode,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CompatibleDataTypes") + // 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. "CompatibleDataTypes") 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 *XPSDataType) MarshalJSON() ([]byte, error) { + type NoMethod XPSDataType + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSDockerFormat: A model format used for Docker containers. Use the +// params field to customize the container. The container is verified to +// work correctly on ubuntu 16.04 operating system. +type XPSDockerFormat struct { + // CpuArchitecture: Optional. Additional cpu information describing the + // requirements for the to be exported model files. + // + // Possible values: + // "CPU_ARCHITECTURE_UNSPECIFIED" + // "CPU_ARCHITECTURE_X86_64" + CpuArchitecture string `json:"cpuArchitecture,omitempty"` + + // GpuArchitecture: Optional. Additional gpu information describing the + // requirements for the to be exported model files. + // + // Possible values: + // "GPU_ARCHITECTURE_UNSPECIFIED" + // "GPU_ARCHITECTURE_NVIDIA" + GpuArchitecture string `json:"gpuArchitecture,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CpuArchitecture") 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. "CpuArchitecture") 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 *XPSDockerFormat) MarshalJSON() ([]byte, error) { + type NoMethod XPSDockerFormat + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSEdgeTpuTfLiteFormat: A model format used for Edge TPU +// (https://cloud.google.com/edge-tpu/) devices. +type XPSEdgeTpuTfLiteFormat struct { +} + +// XPSEvaluationMetrics: Contains xPS-specific model evaluation metrics +// either for a single annotation spec (label), or for the model +// overall. Next tag: 18. +type XPSEvaluationMetrics struct { + // AnnotationSpecIdToken: The annotation_spec for which this evaluation + // metrics instance had been created. Empty iff this is an overall model + // evaluation (like Tables evaluation metrics), i.e. aggregated across + // all labels. The value comes from the input annotations in + // AnnotatedExample. For MVP product or for text sentiment models where + // annotation_spec_id_token is not available, set label instead. + AnnotationSpecIdToken string `json:"annotationSpecIdToken,omitempty"` + + // Category: The integer category label for which this evaluation metric + // instance had been created. Valid categories are 0 or higher. Overall + // model evaluation should set this to negative values (rather than + // implicit zero). Only used for Image Segmentation (prefer to set + // annotation_spec_id_token instead). Note: uCAIP Image Segmentation + // should use annotation_spec_id_token. + Category int64 `json:"category,omitempty"` + + // EvaluatedExampleCount: The number of examples used to create this + // evaluation metrics instance. + EvaluatedExampleCount int64 `json:"evaluatedExampleCount,omitempty"` + + ImageClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"imageClassificationEvalMetrics,omitempty"` + + ImageObjectDetectionEvalMetrics *XPSImageObjectDetectionEvaluationMetrics `json:"imageObjectDetectionEvalMetrics,omitempty"` + + ImageSegmentationEvalMetrics *XPSImageSegmentationEvaluationMetrics `json:"imageSegmentationEvalMetrics,omitempty"` + + // Label: The label for which this evaluation metrics instance had been + // created. Empty iff this is an overall model evaluation (like Tables + // evaluation metrics), i.e. aggregated across all labels. The label + // maps to AnnotationSpec.display_name in Public API protos. Only used + // by MVP implementation and text sentiment FULL implementation. + Label string `json:"label,omitempty"` + + RegressionEvalMetrics *XPSRegressionEvaluationMetrics `json:"regressionEvalMetrics,omitempty"` + + TablesClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"tablesClassificationEvalMetrics,omitempty"` + + TablesEvalMetrics *XPSTablesEvaluationMetrics `json:"tablesEvalMetrics,omitempty"` + + TextClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"textClassificationEvalMetrics,omitempty"` + + TextExtractionEvalMetrics *XPSTextExtractionEvaluationMetrics `json:"textExtractionEvalMetrics,omitempty"` + + TextSentimentEvalMetrics *XPSTextSentimentEvaluationMetrics `json:"textSentimentEvalMetrics,omitempty"` + + TranslationEvalMetrics *XPSTranslationEvaluationMetrics `json:"translationEvalMetrics,omitempty"` + + VideoActionRecognitionEvalMetrics *XPSVideoActionRecognitionEvaluationMetrics `json:"videoActionRecognitionEvalMetrics,omitempty"` + + VideoClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"videoClassificationEvalMetrics,omitempty"` + + VideoObjectTrackingEvalMetrics *XPSVideoObjectTrackingEvaluationMetrics `json:"videoObjectTrackingEvalMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AnnotationSpecIdToken") 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. "AnnotationSpecIdToken") 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 *XPSEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSEvaluationMetricsSet: Specifies location of model evaluation +// metrics. +type XPSEvaluationMetricsSet struct { + // EvaluationMetrics: Inline EvaluationMetrics - should be relatively + // small. For passing large quantities of exhaustive metrics, use + // file_spec. + EvaluationMetrics []*XPSEvaluationMetrics `json:"evaluationMetrics,omitempty"` + + // FileSpec: File spec containing evaluation metrics of a model, must + // point to RecordIO file(s) of + // intelligence.cloud.automl.xps.EvaluationMetrics messages. + FileSpec *XPSFileSpec `json:"fileSpec,omitempty"` + + // NumEvaluationMetrics: Number of the evaluation metrics (usually one + // per label plus overall). + NumEvaluationMetrics int64 `json:"numEvaluationMetrics,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "EvaluationMetrics") + // 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. "EvaluationMetrics") 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 *XPSEvaluationMetricsSet) MarshalJSON() ([]byte, error) { + type NoMethod XPSEvaluationMetricsSet + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSExampleSet: Set of examples or input sources. +type XPSExampleSet struct { + // FileSpec: File spec of the examples or input sources. + FileSpec *XPSFileSpec `json:"fileSpec,omitempty"` + + // Fingerprint: Fingerprint of the example set. + Fingerprint int64 `json:"fingerprint,omitempty,string"` + + // NumExamples: Number of examples. + NumExamples int64 `json:"numExamples,omitempty,string"` + + // NumInputSources: Number of input sources. + NumInputSources int64 `json:"numInputSources,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "FileSpec") 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. "FileSpec") 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 *XPSExampleSet) MarshalJSON() ([]byte, error) { + type NoMethod XPSExampleSet + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSExportModelOutputConfig struct { + CoreMlFormat *XPSCoreMlFormat `json:"coreMlFormat,omitempty"` + + DockerFormat *XPSDockerFormat `json:"dockerFormat,omitempty"` + + EdgeTpuTfLiteFormat *XPSEdgeTpuTfLiteFormat `json:"edgeTpuTfLiteFormat,omitempty"` + + // ExportFirebaseAuxiliaryInfo: For any model and format: If true, will + // additionally export FirebaseExportedModelInfo in a firebase.txt file. + ExportFirebaseAuxiliaryInfo bool `json:"exportFirebaseAuxiliaryInfo,omitempty"` + + // OutputGcrUri: The Google Contained Registry (GCR) path the exported + // files to be pushed to. This location is set if the exported format is + // DOCKDER. + OutputGcrUri string `json:"outputGcrUri,omitempty"` + + // OutputGcsUri: The Google Cloud Storage (GCS) directory where XPS will + // output the exported models and related files. Format: + // gs://bucket/directory + OutputGcsUri string `json:"outputGcsUri,omitempty"` + + TfJsFormat *XPSTfJsFormat `json:"tfJsFormat,omitempty"` + + TfLiteFormat *XPSTfLiteFormat `json:"tfLiteFormat,omitempty"` + + TfSavedModelFormat *XPSTfSavedModelFormat `json:"tfSavedModelFormat,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CoreMlFormat") 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. "CoreMlFormat") 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 *XPSExportModelOutputConfig) MarshalJSON() ([]byte, error) { + type NoMethod XPSExportModelOutputConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSFileSpec: Spec of input and output files, on external file systems +// (CNS, GCS, etc). +type XPSFileSpec struct { + // DirectoryPath: Deprecated. Use file_spec. + DirectoryPath string `json:"directoryPath,omitempty"` + + // Possible values: + // "FILE_FORMAT_UNKNOWN" + // "FILE_FORMAT_SSTABLE" + // "FILE_FORMAT_TRANSLATION_RKV" - Internal format for parallel text + // data used by Google Translate. go/rkvtools + // "FILE_FORMAT_RECORDIO" + // "FILE_FORMAT_RAW_CSV" - Only the lexicographically first file + // described by the file_spec contains the header line. + // "FILE_FORMAT_RAW_CAPACITOR" + FileFormat string `json:"fileFormat,omitempty"` + + // FileSpec: Single file path, or file pattern of format + // "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is + // expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and + // /cns/cell-d/somewhere/file-00001-of-00002. + FileSpec string `json:"fileSpec,omitempty"` + + // SingleFilePath: Deprecated. Use file_spec. + SingleFilePath string `json:"singleFilePath,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DirectoryPath") 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. "DirectoryPath") 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 *XPSFileSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSFileSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSFloat64Stats: The data statistics of a series of FLOAT64 values. +type XPSFloat64Stats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // HistogramBuckets: Histogram buckets of the data series. Sorted by the + // min value of the bucket, ascendingly, and the number of the buckets + // is dynamically generated. The buckets are non-overlapping and + // completely cover whole FLOAT64 range with min of first bucket being + // "-Infinity", and max of the last one being "Infinity". + HistogramBuckets []*XPSFloat64StatsHistogramBucket `json:"histogramBuckets,omitempty"` + + // Mean: The mean of the series. + Mean float64 `json:"mean,omitempty"` + + // Quantiles: Ordered from 0 to k k-quantile values of the data series + // of n values. The value at index i is, approximately, the i*n/k-th + // smallest value in the series; for i = 0 and i = k these are, + // respectively, the min and max values. + Quantiles []float64 `json:"quantiles,omitempty"` + + // StandardDeviation: The standard deviation of the series. + StandardDeviation float64 `json:"standardDeviation,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSFloat64Stats) MarshalJSON() ([]byte, error) { + type NoMethod XPSFloat64Stats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSFloat64Stats) UnmarshalJSON(data []byte) error { + type NoMethod XPSFloat64Stats + var s1 struct { + Mean gensupport.JSONFloat64 `json:"mean"` + Quantiles []gensupport.JSONFloat64 `json:"quantiles"` + StandardDeviation gensupport.JSONFloat64 `json:"standardDeviation"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Mean = float64(s1.Mean) + s.Quantiles = make([]float64, len(s1.Quantiles)) + for i := range s1.Quantiles { + s.Quantiles[i] = float64(s1.Quantiles[i]) + } + s.StandardDeviation = float64(s1.StandardDeviation) + return nil +} + +// XPSFloat64StatsHistogramBucket: A bucket of a histogram. +type XPSFloat64StatsHistogramBucket struct { + // Count: The number of data values that are in the bucket, i.e. are + // between min and max values. + Count int64 `json:"count,omitempty,string"` + + // Max: The maximum value of the bucket, exclusive unless max = + // "Infinity", in which case it's inclusive. + Max float64 `json:"max,omitempty"` + + // Min: The minimum value of the bucket, inclusive. + Min float64 `json:"min,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSFloat64StatsHistogramBucket) MarshalJSON() ([]byte, error) { + type NoMethod XPSFloat64StatsHistogramBucket + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSFloat64StatsHistogramBucket) UnmarshalJSON(data []byte) error { + type NoMethod XPSFloat64StatsHistogramBucket + var s1 struct { + Max gensupport.JSONFloat64 `json:"max"` + Min gensupport.JSONFloat64 `json:"min"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Max = float64(s1.Max) + s.Min = float64(s1.Min) + return nil +} + +type XPSImageClassificationTrainResponse struct { + // ClassCount: Total number of classes. + ClassCount int64 `json:"classCount,omitempty,string"` + + // ExportModelSpec: Information of downloadable models that are + // pre-generated as part of training flow and will be persisted in + // AutoMl backend. Populated for AutoMl requests. + ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` + + // StopReason: Stop reason for training job, e.g. + // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + // + // Possible values: + // "TRAIN_STOP_REASON_UNSPECIFIED" + // "TRAIN_STOP_REASON_BUDGET_REACHED" + // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can + // not be resumbed training. + // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, + // can be further trained till full convergency. + StopReason string `json:"stopReason,omitempty"` + + // TrainCostInNodeTime: The actual cost to create this model. - For edge + // type model, the cost is expressed in node hour. - For cloud type + // model,the cost is expressed in compute hour. - Populated for models + // created before GA. To be deprecated after GA. + TrainCostInNodeTime string `json:"trainCostInNodeTime,omitempty"` + + // TrainCostNodeSeconds: The actual training cost, expressed in node + // seconds. Populated for models trained in node time. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ClassCount") 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. "ClassCount") 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 *XPSImageClassificationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageClassificationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageExportModelSpec: Information of downloadable models that are +// pre-generated as part of training flow and will be persisted in +// AutoMl backend. Upon receiving ExportModel request from user, AutoMl +// backend can serve the pre-generated models to user if exists (by +// copying the files from internal path to user provided location), +// otherwise, AutoMl backend will call xPS ExportModel API to generate +// the model on the fly with the requesting format. +type XPSImageExportModelSpec struct { + // ExportModelOutputConfig: Contains the model format and internal + // location of the model files to be exported/downloaded. Use the GCS + // bucket name which is provided via TrainRequest.gcs_bucket_name to + // store the model files. + ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ExportModelOutputConfig") 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. "ExportModelOutputConfig") + // 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 *XPSImageExportModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageExportModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageModelArtifactSpec: Stores the locations and related metadata +// of the model artifacts. Populated for uCAIP requests only. +type XPSImageModelArtifactSpec struct { + // CheckpointArtifact: The Tensorflow checkpoint files. e.g. Used for + // resumable training. + CheckpointArtifact *XPSModelArtifactItem `json:"checkpointArtifact,omitempty"` + + // ExportArtifact: The model binary files in different formats for model + // export. + ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` + + // LabelGcsUri: GCS uri of decoded labels file for model export + // 'dict.txt'. + LabelGcsUri string `json:"labelGcsUri,omitempty"` + + // ServingArtifact: The default model binary file used for serving (e.g. + // online predict, batch predict) via public Cloud AI Platform API. + ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` + + // TfJsBinaryGcsPrefix: GCS uri prefix of Tensorflow JavaScript binary + // files 'groupX-shardXofX.bin' Deprecated. + TfJsBinaryGcsPrefix string `json:"tfJsBinaryGcsPrefix,omitempty"` + + // TfLiteMetadataGcsUri: GCS uri of Tensorflow Lite metadata + // 'tflite_metadata.json'. + TfLiteMetadataGcsUri string `json:"tfLiteMetadataGcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CheckpointArtifact") + // 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. "CheckpointArtifact") 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 *XPSImageModelArtifactSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageModelArtifactSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageModelServingSpec: Serving specification for image models. +type XPSImageModelServingSpec struct { + // ModelThroughputEstimation: Populate under uCAIP request scope. + ModelThroughputEstimation []*XPSImageModelServingSpecModelThroughputEstimation `json:"modelThroughputEstimation,omitempty"` + + // NodeQps: An estimated value of how much traffic a node can serve. + // Populated for AutoMl request only. + NodeQps float64 `json:"nodeQps,omitempty"` + + // TfRuntimeVersion: ## The fields below are only populated under uCAIP + // request scope. + // https://cloud.google.com/ml-engine/docs/runtime-version-list + TfRuntimeVersion string `json:"tfRuntimeVersion,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ModelThroughputEstimation") 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. + // "ModelThroughputEstimation") 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 *XPSImageModelServingSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageModelServingSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageModelServingSpec) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageModelServingSpec + var s1 struct { + NodeQps gensupport.JSONFloat64 `json:"nodeQps"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.NodeQps = float64(s1.NodeQps) + return nil +} + +type XPSImageModelServingSpecModelThroughputEstimation struct { + // Possible values: + // "UNSPECIFIED" + // "NVIDIA_TESLA_K80" - Nvidia Tesla K80 GPU. + // "NVIDIA_TESLA_P100" - Nvidia Tesla P100 GPU. + // "NVIDIA_TESLA_V100" - Nvidia Tesla V100 GPU. + // "NVIDIA_TESLA_P4" - Nvidia Tesla P4 GPU. + // "NVIDIA_TESLA_T4" - Nvidia Tesla T4 GPU. + // "NVIDIA_TESLA_A100" - Nvidia Tesla A100 GPU. + // "NVIDIA_A100_80GB" - Nvidia A100 80GB GPU. + // "NVIDIA_L4" - Nvidia L4 GPU. + // "NVIDIA_H100_80GB" - Nvidia H100 80Gb GPU. + // "TPU_V2" - TPU v2 (JellyFish). + // "TPU_V3" - TPU v3 (DragonFish). + // "TPU_V4_POD" - TPU_v4 (PufferFish). + // "TPU_V5_LITEPOD" - TPU v5 Lite Pods. + ComputeEngineAcceleratorType string `json:"computeEngineAcceleratorType,omitempty"` + + // LatencyInMilliseconds: Estimated latency. + LatencyInMilliseconds float64 `json:"latencyInMilliseconds,omitempty"` + + // NodeQps: The approximate qps a deployed node can serve. + NodeQps float64 `json:"nodeQps,omitempty"` + + // Possible values: + // "PARTITION_TYPE_UNSPECIFIED" + // "PARTITION_ZERO" - The default partition. + // "PARTITION_REDUCED_HOMING" - It has significantly lower replication + // than partition-0 and is located in the US only. It also has a larger + // model size limit and higher default RAM quota than partition-0. + // Customers with batch traffic, US-based traffic, or very large models + // should use this partition. Capacity in this partition is + // significantly cheaper than partition-0. + // "PARTITION_JELLYFISH" - To be used by customers with + // Jellyfish-accelerated ops. See go/servomatic-jellyfish for details. + // "PARTITION_CPU" - The partition used by regionalized servomatic + // cloud regions. + // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading + // models from custom storage. + ServomaticPartitionType string `json:"servomaticPartitionType,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ComputeEngineAcceleratorType") 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. + // "ComputeEngineAcceleratorType") 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 *XPSImageModelServingSpecModelThroughputEstimation) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageModelServingSpecModelThroughputEstimation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageModelServingSpecModelThroughputEstimation) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageModelServingSpecModelThroughputEstimation + var s1 struct { + LatencyInMilliseconds gensupport.JSONFloat64 `json:"latencyInMilliseconds"` + NodeQps gensupport.JSONFloat64 `json:"nodeQps"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LatencyInMilliseconds = float64(s1.LatencyInMilliseconds) + s.NodeQps = float64(s1.NodeQps) + return nil +} + +// XPSImageObjectDetectionEvaluationMetrics: Model evaluation metrics +// for image object detection problems. Evaluates prediction quality of +// labeled bounding boxes. +type XPSImageObjectDetectionEvaluationMetrics struct { + // BoundingBoxMeanAveragePrecision: The single metric for bounding boxes + // evaluation: the mean_average_precision averaged over all + // bounding_box_metrics_entries. + BoundingBoxMeanAveragePrecision float64 `json:"boundingBoxMeanAveragePrecision,omitempty"` + + // BoundingBoxMetricsEntries: The bounding boxes match metrics for each + // Intersection-over-union threshold + // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence + // threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + BoundingBoxMetricsEntries []*XPSBoundingBoxMetricsEntry `json:"boundingBoxMetricsEntries,omitempty"` + + // EvaluatedBoundingBoxCount: The total number of bounding boxes (i.e. + // summed over all images) the ground truth used to create this + // evaluation had. + EvaluatedBoundingBoxCount int64 `json:"evaluatedBoundingBoxCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BoundingBoxMeanAveragePrecision") 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. + // "BoundingBoxMeanAveragePrecision") 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 *XPSImageObjectDetectionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageObjectDetectionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageObjectDetectionEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageObjectDetectionEvaluationMetrics + var s1 struct { + BoundingBoxMeanAveragePrecision gensupport.JSONFloat64 `json:"boundingBoxMeanAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BoundingBoxMeanAveragePrecision = float64(s1.BoundingBoxMeanAveragePrecision) + return nil +} + +type XPSImageObjectDetectionModelSpec struct { + // ClassCount: Total number of classes. + ClassCount int64 `json:"classCount,omitempty,string"` + + ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` + + // MaxBoundingBoxCount: Max number of bounding box. + MaxBoundingBoxCount int64 `json:"maxBoundingBoxCount,omitempty,string"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` + + // StopReason: Stop reason for training job, e.g. + // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + // + // Possible values: + // "TRAIN_STOP_REASON_UNSPECIFIED" + // "TRAIN_STOP_REASON_BUDGET_REACHED" + // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can + // not be resumbed training. + // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, + // can be further trained till full convergency. + StopReason string `json:"stopReason,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ClassCount") 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. "ClassCount") 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 *XPSImageObjectDetectionModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageObjectDetectionModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageSegmentationEvaluationMetrics: Model evaluation metrics for +// image segmentation problems. Next tag: 4. +type XPSImageSegmentationEvaluationMetrics struct { + // ConfidenceMetricsEntries: Metrics that have confidence thresholds. + // Precision-recall curve can be derived from it. + ConfidenceMetricsEntries []*XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSImageSegmentationEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageSegmentationEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: Metrics +// for a single confidence threshold. +type XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry struct { + // ConfidenceThreshold: The confidence threshold value used to compute + // the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // ConfusionMatrix: Confusion matrix of the per confidence_threshold + // evaluation. Pixel counts are set here. Only set for model level + // evaluation, not for evaluation per label. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // DiceScoreCoefficient: DSC or the F1 score: The harmonic mean of + // recall and precision. + DiceScoreCoefficient float64 `json:"diceScoreCoefficient,omitempty"` + + // IouScore: IOU score. + IouScore float64 `json:"iouScore,omitempty"` + + // Precision: Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // Recall: Recall for the given confidence threshold. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + DiceScoreCoefficient gensupport.JSONFloat64 `json:"diceScoreCoefficient"` + IouScore gensupport.JSONFloat64 `json:"iouScore"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.DiceScoreCoefficient = float64(s1.DiceScoreCoefficient) + s.IouScore = float64(s1.IouScore) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + return nil +} + +type XPSImageSegmentationTrainResponse struct { + // ColorMaps: Color map of the model. + ColorMaps []*XPSColorMap `json:"colorMaps,omitempty"` + + // ExportModelSpec: NOTE: These fields are not used/needed in EAP but + // will be set later. + ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. Model artifact spec stores and model gcs pathes and + // related metadata + ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` + + // StopReason: Stop reason for training job, e.g. + // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. + // + // Possible values: + // "TRAIN_STOP_REASON_UNSPECIFIED" + // "TRAIN_STOP_REASON_BUDGET_REACHED" + // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can + // not be resumbed training. + // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, + // can be further trained till full convergency. + StopReason string `json:"stopReason,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ColorMaps") 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. "ColorMaps") 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 *XPSImageSegmentationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSImageSegmentationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSIntegratedGradientsAttribution: An attribution method that +// computes the Aumann-Shapley value taking advantage of the model's +// fully differentiable structure. Refer to this paper for more details: +// https://arxiv.org/abs/1703.01365 +type XPSIntegratedGradientsAttribution struct { + // StepCount: The number of steps for approximating the path integral. A + // good value to start is 50 and gradually increase until the sum to + // diff property is within the desired error range. Valid range of its + // value is [1, 100], inclusively. + StepCount int64 `json:"stepCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "StepCount") 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. "StepCount") 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 *XPSIntegratedGradientsAttribution) MarshalJSON() ([]byte, error) { + type NoMethod XPSIntegratedGradientsAttribution + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSMetricEntry struct { + // ArgentumMetricId: For billing metrics that are using legacy sku's, + // set the legacy billing metric id here. This will be sent to Chemist + // as the "cloudbilling.googleapis.com/argentum_metric_id" label. + // Otherwise leave empty. + ArgentumMetricId string `json:"argentumMetricId,omitempty"` + + // DoubleValue: A double value. + DoubleValue float64 `json:"doubleValue,omitempty"` + + // Int64Value: A signed 64-bit integer value. + Int64Value int64 `json:"int64Value,omitempty,string"` + + // MetricName: The metric name defined in the service configuration. + MetricName string `json:"metricName,omitempty"` + + // SystemLabels: Billing system labels for this (metric, value) pair. + SystemLabels []*XPSMetricEntryLabel `json:"systemLabels,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ArgentumMetricId") 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. "ArgentumMetricId") 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 *XPSMetricEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSMetricEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSMetricEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSMetricEntry + var s1 struct { + DoubleValue gensupport.JSONFloat64 `json:"doubleValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.DoubleValue = float64(s1.DoubleValue) + return nil +} + +type XPSMetricEntryLabel struct { + // LabelName: The name of the label. + LabelName string `json:"labelName,omitempty"` + + // LabelValue: The value of the label. + LabelValue string `json:"labelValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "LabelName") 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. "LabelName") 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 *XPSMetricEntryLabel) MarshalJSON() ([]byte, error) { + type NoMethod XPSMetricEntryLabel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSModelArtifactItem: A single model artifact item. +type XPSModelArtifactItem struct { + // ArtifactFormat: The model artifact format. + // + // Possible values: + // "ARTIFACT_FORMAT_UNSPECIFIED" - Should not be used. + // "TF_CHECKPOINT" - The Tensorflow checkpoints. See + // https://www.tensorflow.org/guide/checkpoint. + // "TF_SAVED_MODEL" - The Tensorflow SavedModel binary. + // "TF_LITE" - Model artifact in generic TensorFlow Lite (.tflite) + // format. See https://www.tensorflow.org/lite. + // "EDGE_TPU_TF_LITE" - Used for [Edge + // TPU](https://cloud.google.com/edge-tpu/) devices. + // "TF_JS" - A [TensorFlow.js](https://www.tensorflow.org/js) model + // that can be used in the browser and in Node.js using JavaScript. + // "CORE_ML" - Used for iOS mobile devices in (.mlmodel) format. See + // https://developer.apple.com/documentation/coreml + ArtifactFormat string `json:"artifactFormat,omitempty"` + + // GcsUri: The Google Cloud Storage (GCS) uri that stores the model + // binary files. + GcsUri string `json:"gcsUri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ArtifactFormat") 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. "ArtifactFormat") 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 *XPSModelArtifactItem) MarshalJSON() ([]byte, error) { + type NoMethod XPSModelArtifactItem + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSPreprocessResponse: Next ID: 8 +type XPSPreprocessResponse struct { + // OutputExampleSet: Preprocessed examples, that are to be imported into + // AutoML storage. This should point to RecordIO file(s) of + // PreprocessedExample messages. The + // PreprocessedExample.mvp_training_data-s returned here are later + // verbatim passed to Train() call in TrainExample.mvp_training_data. + OutputExampleSet *XPSExampleSet `json:"outputExampleSet,omitempty"` + + SpeechPreprocessResp *XPSSpeechPreprocessResponse `json:"speechPreprocessResp,omitempty"` + + TablesPreprocessResponse *XPSTablesPreprocessResponse `json:"tablesPreprocessResponse,omitempty"` + + TranslationPreprocessResp *XPSTranslationPreprocessResponse `json:"translationPreprocessResp,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OutputExampleSet") 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. "OutputExampleSet") 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 *XPSPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSRegressionEvaluationMetrics: Model evaluation metrics for +// regression problems. It can be used for Tables. +type XPSRegressionEvaluationMetrics struct { + // MeanAbsoluteError: Mean Absolute Error (MAE). + MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` + + // MeanAbsolutePercentageError: Mean absolute percentage error. Only set + // if all ground truth values are positive. + MeanAbsolutePercentageError float64 `json:"meanAbsolutePercentageError,omitempty"` + + // RSquared: R squared. + RSquared float64 `json:"rSquared,omitempty"` + + // RegressionMetricsEntries: A list of actual versus predicted points + // for the model being evaluated. + RegressionMetricsEntries []*XPSRegressionMetricsEntry `json:"regressionMetricsEntries,omitempty"` + + // RootMeanSquaredError: Root Mean Squared Error (RMSE). + RootMeanSquaredError float64 `json:"rootMeanSquaredError,omitempty"` + + // RootMeanSquaredLogError: Root mean squared log error. + RootMeanSquaredLogError float64 `json:"rootMeanSquaredLogError,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MeanAbsoluteError") + // 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. "MeanAbsoluteError") 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 *XPSRegressionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSRegressionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSRegressionEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSRegressionEvaluationMetrics + var s1 struct { + MeanAbsoluteError gensupport.JSONFloat64 `json:"meanAbsoluteError"` + MeanAbsolutePercentageError gensupport.JSONFloat64 `json:"meanAbsolutePercentageError"` + RSquared gensupport.JSONFloat64 `json:"rSquared"` + RootMeanSquaredError gensupport.JSONFloat64 `json:"rootMeanSquaredError"` + RootMeanSquaredLogError gensupport.JSONFloat64 `json:"rootMeanSquaredLogError"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.MeanAbsoluteError = float64(s1.MeanAbsoluteError) + s.MeanAbsolutePercentageError = float64(s1.MeanAbsolutePercentageError) + s.RSquared = float64(s1.RSquared) + s.RootMeanSquaredError = float64(s1.RootMeanSquaredError) + s.RootMeanSquaredLogError = float64(s1.RootMeanSquaredLogError) + return nil +} + +// XPSRegressionMetricsEntry: A pair of actual & observed values for the +// model being evaluated. +type XPSRegressionMetricsEntry struct { + // PredictedValue: The observed value for a row in the dataset. + PredictedValue float64 `json:"predictedValue,omitempty"` + + // TrueValue: The actual target value for a row in the dataset. + TrueValue float64 `json:"trueValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "PredictedValue") 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. "PredictedValue") 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 *XPSRegressionMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSRegressionMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSRegressionMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSRegressionMetricsEntry + var s1 struct { + PredictedValue gensupport.JSONFloat64 `json:"predictedValue"` + TrueValue gensupport.JSONFloat64 `json:"trueValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.PredictedValue = float64(s1.PredictedValue) + s.TrueValue = float64(s1.TrueValue) + return nil +} + +type XPSReportingMetrics struct { + // EffectiveTrainingDuration: The effective time training used. If set, + // this is used for quota management and billing. Deprecated. AutoML BE + // doesn't use this. Don't set. + EffectiveTrainingDuration string `json:"effectiveTrainingDuration,omitempty"` + + // MetricEntries: One entry per metric name. The values must be + // aggregated per metric name. + MetricEntries []*XPSMetricEntry `json:"metricEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EffectiveTrainingDuration") 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. + // "EffectiveTrainingDuration") 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 *XPSReportingMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSReportingMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSResponseExplanationMetadata struct { + // Inputs: Metadata of the input. + Inputs map[string]XPSResponseExplanationMetadataInputMetadata `json:"inputs,omitempty"` + + // Outputs: Metadata of the output. + Outputs map[string]XPSResponseExplanationMetadataOutputMetadata `json:"outputs,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Inputs") 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. "Inputs") 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 *XPSResponseExplanationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSResponseExplanationMetadataInputMetadata: Metadata of the input of +// a feature. +type XPSResponseExplanationMetadataInputMetadata struct { + // InputTensorName: Name of the input tensor for this model. Only needed + // in train response. + InputTensorName string `json:"inputTensorName,omitempty"` + + // Modality: Modality of the feature. Valid values are: numeric, image. + // Defaults to numeric. + // + // Possible values: + // "MODALITY_UNSPECIFIED" + // "NUMERIC" + // "IMAGE" + // "CATEGORICAL" + Modality string `json:"modality,omitempty"` + + // VisualizationConfig: Visualization configurations for image + // explanation. + VisualizationConfig *XPSVisualization `json:"visualizationConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputTensorName") 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. "InputTensorName") 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 *XPSResponseExplanationMetadataInputMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationMetadataInputMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSResponseExplanationMetadataOutputMetadata: Metadata of the +// prediction output to be explained. +type XPSResponseExplanationMetadataOutputMetadata struct { + // OutputTensorName: Name of the output tensor. Only needed in train + // response. + OutputTensorName string `json:"outputTensorName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OutputTensorName") 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. "OutputTensorName") 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 *XPSResponseExplanationMetadataOutputMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationMetadataOutputMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSResponseExplanationParameters struct { + // IntegratedGradientsAttribution: An attribution method that computes + // Aumann-Shapley values taking advantage of the model's fully + // differentiable structure. Refer to this paper for more details: + // https://arxiv.org/abs/1703.01365 + IntegratedGradientsAttribution *XPSIntegratedGradientsAttribution `json:"integratedGradientsAttribution,omitempty"` + + // XraiAttribution: An attribution method that redistributes Integrated + // Gradients attribution to segmented regions, taking advantage of the + // model's fully differentiable structure. Refer to this paper for more + // details: https://arxiv.org/abs/1906.02825 XRAI currently performs + // better on natural images, like a picture of a house or an animal. If + // the images are taken in artificial environments, like a lab or + // manufacturing line, or from diagnostic equipment, like x-rays or + // quality-control cameras, use Integrated Gradients instead. + XraiAttribution *XPSXraiAttribution `json:"xraiAttribution,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "IntegratedGradientsAttribution") 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. + // "IntegratedGradientsAttribution") 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 *XPSResponseExplanationParameters) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationParameters + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSResponseExplanationSpec: Specification of Model explanation. +// Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 +// for context. +type XPSResponseExplanationSpec struct { + // ExplanationType: Explanation type. For AutoML Image Classification + // models, possible values are: * `image-integrated-gradients` * + // `image-xrai` + ExplanationType string `json:"explanationType,omitempty"` + + // Metadata: Metadata describing the Model's input and output for + // explanation. + Metadata *XPSResponseExplanationMetadata `json:"metadata,omitempty"` + + // Parameters: Parameters that configure explaining of the Model's + // predictions. + Parameters *XPSResponseExplanationParameters `json:"parameters,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExplanationType") 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. "ExplanationType") 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 *XPSResponseExplanationSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSResponseExplanationSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSRow struct { + // ColumnIds: The ids of the columns. Note: The below `values` field + // must match order of this field, if this field is set. + ColumnIds []int64 `json:"columnIds,omitempty"` + + // Values: The values of the row cells, given in the same order as the + // column_ids. If column_ids is not set, then in the same order as the + // input_feature_column_ids in TablesModelMetadata. + Values []interface{} `json:"values,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnIds") 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. "ColumnIds") 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 *XPSRow) MarshalJSON() ([]byte, error) { + type NoMethod XPSRow + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechEvaluationMetrics struct { + // SubModelEvaluationMetrics: Evaluation metrics for all submodels + // contained in this model. + SubModelEvaluationMetrics []*XPSSpeechEvaluationMetricsSubModelEvaluationMetric `json:"subModelEvaluationMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "SubModelEvaluationMetrics") 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. + // "SubModelEvaluationMetrics") 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 *XPSSpeechEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechEvaluationMetricsSubModelEvaluationMetric struct { + // BiasingModelType: Type of the biasing model. + // + // Possible values: + // "BIASING_MODEL_TYPE_UNSPECIFIED" + // "COMMAND_AND_SEARCH" - Build biasing model on top of + // COMMAND_AND_SEARCH model + // "PHONE_CALL" - Build biasing model on top of PHONE_CALL model + // "VIDEO" - Build biasing model on top of VIDEO model + // "DEFAULT" - Build biasing model on top of DEFAULT model + BiasingModelType string `json:"biasingModelType,omitempty"` + + // IsEnhancedModel: If true then it means we have an enhanced version of + // the biasing models. + IsEnhancedModel bool `json:"isEnhancedModel,omitempty"` + + NumDeletions int64 `json:"numDeletions,omitempty"` + + NumInsertions int64 `json:"numInsertions,omitempty"` + + NumSubstitutions int64 `json:"numSubstitutions,omitempty"` + + // NumUtterances: Number of utterances used in the wer computation. + NumUtterances int64 `json:"numUtterances,omitempty"` + + // NumWords: Number of words over which the word error rate was + // computed. + NumWords int64 `json:"numWords,omitempty"` + + // SentenceAccuracy: Below fields are used for debugging purposes + SentenceAccuracy float64 `json:"sentenceAccuracy,omitempty"` + + // Wer: Word error rate (standard error metric used for speech + // recognition). + Wer float64 `json:"wer,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BiasingModelType") 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. "BiasingModelType") 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 *XPSSpeechEvaluationMetricsSubModelEvaluationMetric) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechEvaluationMetricsSubModelEvaluationMetric + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSSpeechEvaluationMetricsSubModelEvaluationMetric) UnmarshalJSON(data []byte) error { + type NoMethod XPSSpeechEvaluationMetricsSubModelEvaluationMetric + var s1 struct { + SentenceAccuracy gensupport.JSONFloat64 `json:"sentenceAccuracy"` + Wer gensupport.JSONFloat64 `json:"wer"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.SentenceAccuracy = float64(s1.SentenceAccuracy) + s.Wer = float64(s1.Wer) + return nil +} + +type XPSSpeechModelSpec struct { + // DatasetId: Required for speech xps backend. Speech xps has to use + // dataset_id and model_id as the primary key in db so that speech API + // can query the db directly. + DatasetId int64 `json:"datasetId,omitempty,string"` + + Language string `json:"language,omitempty"` + + // SubModelSpecs: Model specs for all submodels contained in this model. + SubModelSpecs []*XPSSpeechModelSpecSubModelSpec `json:"subModelSpecs,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DatasetId") 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. "DatasetId") 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 *XPSSpeechModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechModelSpecSubModelSpec struct { + // BiasingModelType: Type of the biasing model. + // + // Possible values: + // "BIASING_MODEL_TYPE_UNSPECIFIED" + // "COMMAND_AND_SEARCH" - Build biasing model on top of + // COMMAND_AND_SEARCH model + // "PHONE_CALL" - Build biasing model on top of PHONE_CALL model + // "VIDEO" - Build biasing model on top of VIDEO model + // "DEFAULT" - Build biasing model on top of DEFAULT model + BiasingModelType string `json:"biasingModelType,omitempty"` + + // ClientId: In S3, Recognition ClientContextId.client_id + ClientId string `json:"clientId,omitempty"` + + // ContextId: In S3, Recognition ClientContextId.context_id + ContextId string `json:"contextId,omitempty"` + + // IsEnhancedModel: If true then it means we have an enhanced version of + // the biasing models. + IsEnhancedModel bool `json:"isEnhancedModel,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BiasingModelType") 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. "BiasingModelType") 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 *XPSSpeechModelSpecSubModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechModelSpecSubModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechPreprocessResponse struct { + // CnsTestDataPath: Location od shards of sstables (test data) of + // DataUtterance protos. + CnsTestDataPath string `json:"cnsTestDataPath,omitempty"` + + // CnsTrainDataPath: Location of shards of sstables (training data) of + // DataUtterance protos. + CnsTrainDataPath string `json:"cnsTrainDataPath,omitempty"` + + // PrebuiltModelEvaluationMetrics: The metrics for prebuilt speech + // models. They are included here because there is no prebuilt speech + // models stored in the AutoML. + PrebuiltModelEvaluationMetrics *XPSSpeechEvaluationMetrics `json:"prebuiltModelEvaluationMetrics,omitempty"` + + // SpeechPreprocessStats: Stats associated with the data. + SpeechPreprocessStats *XPSSpeechPreprocessStats `json:"speechPreprocessStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CnsTestDataPath") 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. "CnsTestDataPath") 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 *XPSSpeechPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSSpeechPreprocessStats struct { + // DataErrors: Different types of data errors and the counts associated + // with them. + DataErrors []*XPSDataErrors `json:"dataErrors,omitempty"` + + // NumHumanLabeledExamples: The number of rows marked HUMAN_LABELLED + NumHumanLabeledExamples int64 `json:"numHumanLabeledExamples,omitempty"` + + // NumLogsExamples: The number of samples found in the previously + // recorded logs data. + NumLogsExamples int64 `json:"numLogsExamples,omitempty"` + + // NumMachineTranscribedExamples: The number of rows marked as + // MACHINE_TRANSCRIBED + NumMachineTranscribedExamples int64 `json:"numMachineTranscribedExamples,omitempty"` + + // TestExamplesCount: The number of examples labelled as TEST by Speech + // xps server. + TestExamplesCount int64 `json:"testExamplesCount,omitempty"` + + // TestSentencesCount: The number of sentences in the test data set. + TestSentencesCount int64 `json:"testSentencesCount,omitempty"` + + // TestWordsCount: The number of words in the test data set. + TestWordsCount int64 `json:"testWordsCount,omitempty"` + + // TrainExamplesCount: The number of examples labeled as TRAIN by Speech + // xps server. + TrainExamplesCount int64 `json:"trainExamplesCount,omitempty"` + + // TrainSentencesCount: The number of sentences in the training data + // set. + TrainSentencesCount int64 `json:"trainSentencesCount,omitempty"` + + // TrainWordsCount: The number of words in the training data set. + TrainWordsCount int64 `json:"trainWordsCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DataErrors") 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. "DataErrors") 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 *XPSSpeechPreprocessStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSSpeechPreprocessStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStringStats: The data statistics of a series of STRING values. +type XPSStringStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // TopUnigramStats: The statistics of the top 20 unigrams, ordered by + // StringStats.UnigramStats.count. + TopUnigramStats []*XPSStringStatsUnigramStats `json:"topUnigramStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSStringStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSStringStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStringStatsUnigramStats: The statistics of a unigram. +type XPSStringStatsUnigramStats struct { + // Count: The number of occurrences of this unigram in the series. + Count int64 `json:"count,omitempty,string"` + + // Value: The unigram. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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 *XPSStringStatsUnigramStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSStringStatsUnigramStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStructStats: The data statistics of a series of STRUCT values. +type XPSStructStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // FieldStats: Map from a field name of the struct to data stats + // aggregated over series of all data in that field across all the + // structs. + FieldStats map[string]XPSDataStats `json:"fieldStats,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSStructStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSStructStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSStructType: `StructType` defines the DataType-s of a STRUCT type. +type XPSStructType struct { + // Fields: Unordered map of struct field names to their data types. + Fields map[string]XPSDataType `json:"fields,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Fields") 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. "Fields") 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 *XPSStructType) MarshalJSON() ([]byte, error) { + type NoMethod XPSStructType + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTableSpec struct { + // ColumnSpecs: Mapping from column id to column spec. + ColumnSpecs map[string]XPSColumnSpec `json:"columnSpecs,omitempty"` + + // ImportedDataSizeInBytes: The total size of imported data of the + // table. + ImportedDataSizeInBytes int64 `json:"importedDataSizeInBytes,omitempty,string"` + + // RowCount: The number of rows in the table. + RowCount int64 `json:"rowCount,omitempty,string"` + + // TimeColumnId: The id of the time column. + TimeColumnId int64 `json:"timeColumnId,omitempty"` + + // ValidRowCount: The number of valid rows. + ValidRowCount int64 `json:"validRowCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ColumnSpecs") 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. "ColumnSpecs") 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 *XPSTableSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSTableSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesClassificationMetrics: Metrics for Tables classification +// problems. +type XPSTablesClassificationMetrics struct { + // CurveMetrics: Metrics building a curve. + CurveMetrics []*XPSTablesClassificationMetricsCurveMetrics `json:"curveMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CurveMetrics") 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. "CurveMetrics") 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 *XPSTablesClassificationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesClassificationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesClassificationMetricsCurveMetrics: Metrics curve data point +// for a single value. +type XPSTablesClassificationMetricsCurveMetrics struct { + // AucPr: The area under the precision-recall curve. + AucPr float64 `json:"aucPr,omitempty"` + + // AucRoc: The area under receiver operating characteristic curve. + AucRoc float64 `json:"aucRoc,omitempty"` + + // ConfidenceMetricsEntries: Metrics that have confidence thresholds. + // Precision-recall curve and ROC curve can be derived from them. + ConfidenceMetricsEntries []*XPSTablesConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // LogLoss: The Log loss metric. + LogLoss float64 `json:"logLoss,omitempty"` + + // PositionThreshold: The position threshold value used to compute the + // metrics. + PositionThreshold int64 `json:"positionThreshold,omitempty"` + + // Value: The CATEGORY row value (for ARRAY unnested) the curve metrics + // are for. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AucPr") 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. "AucPr") 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 *XPSTablesClassificationMetricsCurveMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesClassificationMetricsCurveMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesClassificationMetricsCurveMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesClassificationMetricsCurveMetrics + var s1 struct { + AucPr gensupport.JSONFloat64 `json:"aucPr"` + AucRoc gensupport.JSONFloat64 `json:"aucRoc"` + LogLoss gensupport.JSONFloat64 `json:"logLoss"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.AucPr = float64(s1.AucPr) + s.AucRoc = float64(s1.AucRoc) + s.LogLoss = float64(s1.LogLoss) + return nil +} + +// XPSTablesConfidenceMetricsEntry: Metrics for a single confidence +// threshold. +type XPSTablesConfidenceMetricsEntry struct { + // ConfidenceThreshold: The confidence threshold value used to compute + // the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: The harmonic mean of recall and precision. (2 * precision * + // recall) / (precision + recall) + F1Score float64 `json:"f1Score,omitempty"` + + // FalseNegativeCount: False negative count. + FalseNegativeCount int64 `json:"falseNegativeCount,omitempty,string"` + + // FalsePositiveCount: False positive count. + FalsePositiveCount int64 `json:"falsePositiveCount,omitempty,string"` + + // FalsePositiveRate: FPR = #false positives / (#false positives + #true + // negatives) + FalsePositiveRate float64 `json:"falsePositiveRate,omitempty"` + + // Precision: Precision = #true positives / (#true positives + #false + // positives). + Precision float64 `json:"precision,omitempty"` + + // Recall: Recall = #true positives / (#true positives + #false + // negatives). + Recall float64 `json:"recall,omitempty"` + + // TrueNegativeCount: True negative count. + TrueNegativeCount int64 `json:"trueNegativeCount,omitempty,string"` + + // TruePositiveCount: True positive count. + TruePositiveCount int64 `json:"truePositiveCount,omitempty,string"` + + // TruePositiveRate: TPR = #true positives / (#true positives + #false + // negatvies) + TruePositiveRate float64 `json:"truePositiveRate,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSTablesConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + FalsePositiveRate gensupport.JSONFloat64 `json:"falsePositiveRate"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + TruePositiveRate gensupport.JSONFloat64 `json:"truePositiveRate"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.FalsePositiveRate = float64(s1.FalsePositiveRate) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + s.TruePositiveRate = float64(s1.TruePositiveRate) + return nil +} + +// XPSTablesDatasetMetadata: Metadata for a dataset used for AutoML +// Tables. Next ID: 6 +type XPSTablesDatasetMetadata struct { + // MlUseColumnId: Id the column to split the table. + MlUseColumnId int64 `json:"mlUseColumnId,omitempty"` + + // PrimaryTableSpec: Primary table. + PrimaryTableSpec *XPSTableSpec `json:"primaryTableSpec,omitempty"` + + // TargetColumnCorrelations: (the column id : its CorrelationStats with + // target column). + TargetColumnCorrelations map[string]XPSCorrelationStats `json:"targetColumnCorrelations,omitempty"` + + // TargetColumnId: Id of the primary table column that should be used as + // the training label. + TargetColumnId int64 `json:"targetColumnId,omitempty"` + + // WeightColumnId: Id of the primary table column that should be used as + // the weight column. + WeightColumnId int64 `json:"weightColumnId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MlUseColumnId") 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. "MlUseColumnId") 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 *XPSTablesDatasetMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesDatasetMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTablesEvaluationMetrics struct { + // ClassificationMetrics: Classification metrics. + ClassificationMetrics *XPSTablesClassificationMetrics `json:"classificationMetrics,omitempty"` + + // RegressionMetrics: Regression metrics. + RegressionMetrics *XPSTablesRegressionMetrics `json:"regressionMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ClassificationMetrics") 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. "ClassificationMetrics") 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 *XPSTablesEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesModelColumnInfo: An information specific to given column and +// Tables Model, in context of the Model and the predictions created by +// it. +type XPSTablesModelColumnInfo struct { + // ColumnId: The ID of the column. + ColumnId int64 `json:"columnId,omitempty"` + + // FeatureImportance: When given as part of a Model: Measurement of how + // much model predictions correctness on the TEST data depend on values + // in this column. A value between 0 and 1, higher means higher + // influence. These values are normalized - for all input feature + // columns of a given model they add to 1. When given back by Predict or + // Batch Predict: Measurement of how impactful for the prediction + // returned for the given row the value in this column was. + // Specifically, the feature importance specifies the marginal + // contribution that the feature made to the prediction score compared + // to the baseline score. These values are computed using the Sampled + // Shapley method. + FeatureImportance float64 `json:"featureImportance,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ColumnId") 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. "ColumnId") 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 *XPSTablesModelColumnInfo) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelColumnInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesModelColumnInfo) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesModelColumnInfo + var s1 struct { + FeatureImportance gensupport.JSONFloat64 `json:"featureImportance"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.FeatureImportance = float64(s1.FeatureImportance) + return nil +} + +// XPSTablesModelStructure: A description of Tables model structure. +type XPSTablesModelStructure struct { + // ModelParameters: A list of models. + ModelParameters []*XPSTablesModelStructureModelParameters `json:"modelParameters,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ModelParameters") 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. "ModelParameters") 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 *XPSTablesModelStructure) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelStructure + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesModelStructureModelParameters: Model hyper-parameters for a +// model. +type XPSTablesModelStructureModelParameters struct { + Hyperparameters []*XPSTablesModelStructureModelParametersParameter `json:"hyperparameters,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Hyperparameters") 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. "Hyperparameters") 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 *XPSTablesModelStructureModelParameters) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelStructureModelParameters + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTablesModelStructureModelParametersParameter struct { + // FloatValue: Float type parameter value. + FloatValue float64 `json:"floatValue,omitempty"` + + // IntValue: Integer type parameter value. + IntValue int64 `json:"intValue,omitempty,string"` + + // Name: Parameter name. + Name string `json:"name,omitempty"` + + // StringValue: String type parameter value. + StringValue string `json:"stringValue,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FloatValue") 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. "FloatValue") 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 *XPSTablesModelStructureModelParametersParameter) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesModelStructureModelParametersParameter + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesModelStructureModelParametersParameter) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesModelStructureModelParametersParameter + var s1 struct { + FloatValue gensupport.JSONFloat64 `json:"floatValue"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.FloatValue = float64(s1.FloatValue) + return nil +} + +type XPSTablesPreprocessResponse struct { + // TablesDatasetMetadata: The table/column id, column_name and the + // DataTypes of the columns will be populated. + TablesDatasetMetadata *XPSTablesDatasetMetadata `json:"tablesDatasetMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "TablesDatasetMetadata") 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. "TablesDatasetMetadata") 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 *XPSTablesPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTablesRegressionMetrics: Metrics for Tables regression problems. +type XPSTablesRegressionMetrics struct { + // MeanAbsoluteError: Mean absolute error. + MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` + + // MeanAbsolutePercentageError: Mean absolute percentage error, only set + // if all of the target column's values are positive. + MeanAbsolutePercentageError float64 `json:"meanAbsolutePercentageError,omitempty"` + + // RSquared: R squared. + RSquared float64 `json:"rSquared,omitempty"` + + // RegressionMetricsEntries: A list of actual versus predicted points + // for the model being evaluated. + RegressionMetricsEntries []*XPSRegressionMetricsEntry `json:"regressionMetricsEntries,omitempty"` + + // RootMeanSquaredError: Root mean squared error. + RootMeanSquaredError float64 `json:"rootMeanSquaredError,omitempty"` + + // RootMeanSquaredLogError: Root mean squared log error. + RootMeanSquaredLogError float64 `json:"rootMeanSquaredLogError,omitempty"` + + // ForceSendFields is a list of field names (e.g. "MeanAbsoluteError") + // 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. "MeanAbsoluteError") 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 *XPSTablesRegressionMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesRegressionMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTablesRegressionMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTablesRegressionMetrics + var s1 struct { + MeanAbsoluteError gensupport.JSONFloat64 `json:"meanAbsoluteError"` + MeanAbsolutePercentageError gensupport.JSONFloat64 `json:"meanAbsolutePercentageError"` + RSquared gensupport.JSONFloat64 `json:"rSquared"` + RootMeanSquaredError gensupport.JSONFloat64 `json:"rootMeanSquaredError"` + RootMeanSquaredLogError gensupport.JSONFloat64 `json:"rootMeanSquaredLogError"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.MeanAbsoluteError = float64(s1.MeanAbsoluteError) + s.MeanAbsolutePercentageError = float64(s1.MeanAbsolutePercentageError) + s.RSquared = float64(s1.RSquared) + s.RootMeanSquaredError = float64(s1.RootMeanSquaredError) + s.RootMeanSquaredLogError = float64(s1.RootMeanSquaredLogError) + return nil +} + +type XPSTablesTrainResponse struct { + ModelStructure *XPSTablesModelStructure `json:"modelStructure,omitempty"` + + // PredictionSampleRows: Sample rows from the dataset this model was + // trained. + PredictionSampleRows []*XPSRow `json:"predictionSampleRows,omitempty"` + + // TablesModelColumnInfo: Output only. Auxiliary information for each of + // the input_feature_column_specs, with respect to this particular + // model. + TablesModelColumnInfo []*XPSTablesModelColumnInfo `json:"tablesModelColumnInfo,omitempty"` + + // TrainCostMilliNodeHours: The actual training cost of the model, + // expressed in milli node hours, i.e. 1,000 value in this field means 1 + // node hour. Guaranteed to not exceed the train budget. + TrainCostMilliNodeHours int64 `json:"trainCostMilliNodeHours,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ModelStructure") 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. "ModelStructure") 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 *XPSTablesTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTablesTrainingOperationMetadata struct { + // CreateModelStage: Current stage of creating model. + // + // Possible values: + // "CREATE_MODEL_STAGE_UNSPECIFIED" - Unspecified stage. + // "DATA_PREPROCESSING" - Prepare the model training pipeline and run + // data processing. + // "TRAINING" - Training model. + // "EVALUATING" - Run evaluation. + // "MODEL_POST_PROCESSING" - Finalizing model training pipeline. + CreateModelStage string `json:"createModelStage,omitempty"` + + // OptimizationObjective: The optimization objective for model. + OptimizationObjective string `json:"optimizationObjective,omitempty"` + + // TopTrials: This field is for training. When the operation is + // terminated successfully, AutoML Backend post this field to operation + // metadata in spanner. If the metadata has no trials returned, the + // training operation is supposed to be a failure. + TopTrials []*XPSTuningTrial `json:"topTrials,omitempty"` + + // TrainBudgetMilliNodeHours: Creating model budget. + TrainBudgetMilliNodeHours int64 `json:"trainBudgetMilliNodeHours,omitempty,string"` + + // TrainingObjectivePoints: This field records the training objective + // value with respect to time, giving insight into how the model + // architecture search is performing as training time elapses. + TrainingObjectivePoints []*XPSTrainingObjectivePoint `json:"trainingObjectivePoints,omitempty"` + + // TrainingStartTime: Timestamp when training process starts. + TrainingStartTime string `json:"trainingStartTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateModelStage") 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. "CreateModelStage") 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 *XPSTablesTrainingOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSTablesTrainingOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTextComponentModel: Component model. Next ID: 10 +type XPSTextComponentModel struct { + // BatchPredictionModelGcsUri: The Cloud Storage resource path to hold + // batch prediction model. + BatchPredictionModelGcsUri string `json:"batchPredictionModelGcsUri,omitempty"` + + // OnlinePredictionModelGcsUri: The Cloud Storage resource path to hold + // online prediction model. + OnlinePredictionModelGcsUri string `json:"onlinePredictionModelGcsUri,omitempty"` + + // Partition: The partition where the model is deployed. Populated by + // uCAIP BE as part of online PredictRequest. + // + // Possible values: + // "PARTITION_TYPE_UNSPECIFIED" + // "PARTITION_ZERO" - The default partition. + // "PARTITION_REDUCED_HOMING" - It has significantly lower replication + // than partition-0 and is located in the US only. It also has a larger + // model size limit and higher default RAM quota than partition-0. + // Customers with batch traffic, US-based traffic, or very large models + // should use this partition. Capacity in this partition is + // significantly cheaper than partition-0. + // "PARTITION_JELLYFISH" - To be used by customers with + // Jellyfish-accelerated ops. See go/servomatic-jellyfish for details. + // "PARTITION_CPU" - The partition used by regionalized servomatic + // cloud regions. + // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading + // models from custom storage. + Partition string `json:"partition,omitempty"` + + // ServingArtifact: The default model binary file used for serving (e.g. + // online predict, batch predict) via public Cloud Ai Platform API. + ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` + + // ServoModelName: The name of servo model. Populated by uCAIP BE as + // part of online PredictRequest. + ServoModelName string `json:"servoModelName,omitempty"` + + // SubmodelName: The name of the trained NL submodel. + SubmodelName string `json:"submodelName,omitempty"` + + // SubmodelType: The type of trained NL submodel + // + // Possible values: + // "TEXT_MODEL_TYPE_UNSPECIFIED" + // "TEXT_MODEL_TYPE_DEFAULT" + // "TEXT_MODEL_TYPE_META_ARCHITECT" + // "TEXT_MODEL_TYPE_ATC" + // "TEXT_MODEL_TYPE_CLARA2" + // "TEXT_MODEL_TYPE_CHATBASE" + // "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING" + // "TEXT_MODEL_TYPE_TEXT_EXTRACTION" - Model type for entity + // extraction. + // "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION" - Model type for + // relationship extraction. + // "TEXT_MODEL_TYPE_COMPOSITE" - A composite model represents a set of + // component models that have to be used together for prediction. A + // composite model appears to be a single model to the model user. It + // may contain only one component model. Please refer to + // go/cnl-composite-models for more information. + // "TEXT_MODEL_TYPE_ALL_MODELS" - Model type used to train default, + // MA, and ATC models in a single batch worker pipeline. + // "TEXT_MODEL_TYPE_BERT" - BERT pipeline needs a specific model type, + // since it uses a different TFX configuration compared with DEFAULT + // (despite sharing most of the code). + // "TEXT_MODEL_TYPE_ENC_PALM" - Model type for EncPaLM. + SubmodelType string `json:"submodelType,omitempty"` + + // TfRuntimeVersion: ## The fields below are only populated under uCAIP + // request scope. + // https://cloud.google.com/ml-engine/docs/runtime-version-list + TfRuntimeVersion string `json:"tfRuntimeVersion,omitempty"` + + // VersionNumber: The servomatic model version number. Populated by + // uCAIP BE as part of online PredictRequest. + VersionNumber int64 `json:"versionNumber,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. + // "BatchPredictionModelGcsUri") 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. + // "BatchPredictionModelGcsUri") 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 *XPSTextComponentModel) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextComponentModel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTextExtractionEvaluationMetrics struct { + // BestF1ConfidenceMetrics: Values are at the highest F1 score on the + // precision-recall curve. Only confidence_threshold, recall, precision, + // and f1_score will be set. + BestF1ConfidenceMetrics *XPSConfidenceMetricsEntry `json:"bestF1ConfidenceMetrics,omitempty"` + + // ConfidenceMetricsEntries: If the enclosing EvaluationMetrics.label is + // empty, confidence_metrics_entries is an evaluation of the entire + // model across all labels. If the enclosing EvaluationMetrics.label is + // set, confidence_metrics_entries applies to that label. + ConfidenceMetricsEntries []*XPSConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // ConfusionMatrix: Confusion matrix of the model, at the default + // confidence threshold (0.0). Only set for whole-model evaluation, not + // for evaluation per label. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // PerLabelConfidenceMetrics: Only recall, precision, and f1_score will + // be set. + PerLabelConfidenceMetrics map[string]XPSConfidenceMetricsEntry `json:"perLabelConfidenceMetrics,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BestF1ConfidenceMetrics") 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. "BestF1ConfidenceMetrics") + // 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 *XPSTextExtractionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextExtractionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTextSentimentEvaluationMetrics: Model evaluation metrics for text +// sentiment problems. +type XPSTextSentimentEvaluationMetrics struct { + // ConfusionMatrix: Output only. Confusion matrix of the evaluation. + // Only set for the overall model evaluation, not for evaluation of a + // single annotation spec. + ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` + + // F1Score: Output only. The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // LinearKappa: Output only. Linear weighted kappa. Only set for the + // overall model evaluation, not for evaluation of a single annotation + // spec. + LinearKappa float64 `json:"linearKappa,omitempty"` + + // MeanAbsoluteError: Output only. Mean absolute error. Only set for the + // overall model evaluation, not for evaluation of a single annotation + // spec. + MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` + + // MeanSquaredError: Output only. Mean squared error. Only set for the + // overall model evaluation, not for evaluation of a single annotation + // spec. + MeanSquaredError float64 `json:"meanSquaredError,omitempty"` + + // Precision: Output only. Precision. + Precision float64 `json:"precision,omitempty"` + + // QuadraticKappa: Output only. Quadratic weighted kappa. Only set for + // the overall model evaluation, not for evaluation of a single + // annotation spec. + QuadraticKappa float64 `json:"quadraticKappa,omitempty"` + + // Recall: Output only. Recall. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfusionMatrix") 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. "ConfusionMatrix") 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 *XPSTextSentimentEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextSentimentEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTextSentimentEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTextSentimentEvaluationMetrics + var s1 struct { + F1Score gensupport.JSONFloat64 `json:"f1Score"` + LinearKappa gensupport.JSONFloat64 `json:"linearKappa"` + MeanAbsoluteError gensupport.JSONFloat64 `json:"meanAbsoluteError"` + MeanSquaredError gensupport.JSONFloat64 `json:"meanSquaredError"` + Precision gensupport.JSONFloat64 `json:"precision"` + QuadraticKappa gensupport.JSONFloat64 `json:"quadraticKappa"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.F1Score = float64(s1.F1Score) + s.LinearKappa = float64(s1.LinearKappa) + s.MeanAbsoluteError = float64(s1.MeanAbsoluteError) + s.MeanSquaredError = float64(s1.MeanSquaredError) + s.Precision = float64(s1.Precision) + s.QuadraticKappa = float64(s1.QuadraticKappa) + s.Recall = float64(s1.Recall) + return nil +} + +// XPSTextToSpeechTrainResponse: TextToSpeech train response +type XPSTextToSpeechTrainResponse struct { +} + +type XPSTextTrainResponse struct { + // ComponentModel: Component submodels. + ComponentModel []*XPSTextComponentModel `json:"componentModel,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ComponentModel") 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. "ComponentModel") 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 *XPSTextTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTextTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTfJsFormat: A TensorFlow.js (https://www.tensorflow.org/js) model +// that can be used in the browser and in Node.js using JavaScript. +type XPSTfJsFormat struct { +} + +// XPSTfLiteFormat: LINT.IfChange A model format used for mobile and IoT +// devices. See https://www.tensorflow.org/lite. +type XPSTfLiteFormat struct { +} + +// XPSTfSavedModelFormat: A tensorflow model format in SavedModel +// format. +type XPSTfSavedModelFormat struct { +} + +// XPSTimestampStats: The data statistics of a series of TIMESTAMP +// values. +type XPSTimestampStats struct { + CommonStats *XPSCommonStats `json:"commonStats,omitempty"` + + // GranularStats: The string key is the pre-defined granularity. + // Currently supported: hour_of_day, day_of_week, month_of_year. + // Granularities finer that the granularity of timestamp data are not + // populated (e.g. if timestamps are at day granularity, then + // hour_of_day is not populated). + GranularStats map[string]XPSTimestampStatsGranularStats `json:"granularStats,omitempty"` + + MedianTimestampNanos int64 `json:"medianTimestampNanos,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "CommonStats") 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. "CommonStats") 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 *XPSTimestampStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSTimestampStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTimestampStatsGranularStats: Stats split by a defined in context +// granularity. +type XPSTimestampStatsGranularStats struct { + // Buckets: A map from granularity key to example count for that key. + // E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means + // May). + Buckets map[string]string `json:"buckets,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Buckets") 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. "Buckets") 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 *XPSTimestampStatsGranularStats) MarshalJSON() ([]byte, error) { + type NoMethod XPSTimestampStatsGranularStats + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTrackMetricsEntry: Track matching model metrics for a single track +// match threshold and multiple label match confidence thresholds. Next +// tag: 6. +type XPSTrackMetricsEntry struct { + // ConfidenceMetricsEntries: Output only. Metrics for each label-match + // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + // Precision-recall curve is derived from them. + ConfidenceMetricsEntries []*XPSTrackMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // IouThreshold: Output only. The intersection-over-union threshold + // value between bounding boxes across frames used to compute this + // metric entry. + IouThreshold float64 `json:"iouThreshold,omitempty"` + + // MeanBoundingBoxIou: Output only. The mean bounding box iou over all + // confidence thresholds. + MeanBoundingBoxIou float64 `json:"meanBoundingBoxIou,omitempty"` + + // MeanMismatchRate: Output only. The mean mismatch rate over all + // confidence thresholds. + MeanMismatchRate float64 `json:"meanMismatchRate,omitempty"` + + // MeanTrackingAveragePrecision: Output only. The mean average precision + // over all confidence thresholds. + MeanTrackingAveragePrecision float64 `json:"meanTrackingAveragePrecision,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSTrackMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrackMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTrackMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSTrackMetricsEntry + var s1 struct { + IouThreshold gensupport.JSONFloat64 `json:"iouThreshold"` + MeanBoundingBoxIou gensupport.JSONFloat64 `json:"meanBoundingBoxIou"` + MeanMismatchRate gensupport.JSONFloat64 `json:"meanMismatchRate"` + MeanTrackingAveragePrecision gensupport.JSONFloat64 `json:"meanTrackingAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.IouThreshold = float64(s1.IouThreshold) + s.MeanBoundingBoxIou = float64(s1.MeanBoundingBoxIou) + s.MeanMismatchRate = float64(s1.MeanMismatchRate) + s.MeanTrackingAveragePrecision = float64(s1.MeanTrackingAveragePrecision) + return nil +} + +// XPSTrackMetricsEntryConfidenceMetricsEntry: Metrics for a single +// confidence threshold. Next tag: 6. +type XPSTrackMetricsEntryConfidenceMetricsEntry struct { + // BoundingBoxIou: Output only. Bounding box intersection-over-union + // precision. Measures how well the bounding boxes overlap between each + // other (e.g. complete overlap or just barely above iou_threshold). + BoundingBoxIou float64 `json:"boundingBoxIou,omitempty"` + + // ConfidenceThreshold: Output only. The confidence threshold value used + // to compute the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // MismatchRate: Output only. Mismatch rate, which measures the tracking + // consistency, i.e. correctness of instance ID continuity. + MismatchRate float64 `json:"mismatchRate,omitempty"` + + // TrackingPrecision: Output only. Tracking precision. + TrackingPrecision float64 `json:"trackingPrecision,omitempty"` + + // TrackingRecall: Output only. Tracking recall. + TrackingRecall float64 `json:"trackingRecall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BoundingBoxIou") 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. "BoundingBoxIou") 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 *XPSTrackMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrackMetricsEntryConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSTrackMetricsEntryConfidenceMetricsEntry + var s1 struct { + BoundingBoxIou gensupport.JSONFloat64 `json:"boundingBoxIou"` + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + MismatchRate gensupport.JSONFloat64 `json:"mismatchRate"` + TrackingPrecision gensupport.JSONFloat64 `json:"trackingPrecision"` + TrackingRecall gensupport.JSONFloat64 `json:"trackingRecall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BoundingBoxIou = float64(s1.BoundingBoxIou) + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.MismatchRate = float64(s1.MismatchRate) + s.TrackingPrecision = float64(s1.TrackingPrecision) + s.TrackingRecall = float64(s1.TrackingRecall) + return nil +} + +// XPSTrainResponse: Next ID: 18 +type XPSTrainResponse struct { + // DeployedModelSizeBytes: Estimated model size in bytes once deployed. + DeployedModelSizeBytes int64 `json:"deployedModelSizeBytes,omitempty,string"` + + // ErrorAnalysisConfigs: Optional vision model error analysis + // configuration. The field is set when model error analysis is enabled + // in the training request. The results of error analysis will be binded + // together with evaluation results (in the format of AnnotatedExample). + ErrorAnalysisConfigs []*XPSVisionErrorAnalysisConfig `json:"errorAnalysisConfigs,omitempty"` + + // EvaluatedExampleSet: Examples used to evaluate the model (usually the + // test set), with the predicted annotations. The file_spec should point + // to recordio file(s) of AnnotatedExample. For each returned example, + // the example_id_token and annotations predicted by the model must be + // set. The example payload can and is recommended to be omitted. + EvaluatedExampleSet *XPSExampleSet `json:"evaluatedExampleSet,omitempty"` + + // EvaluationMetricsSet: The trained model evaluation metrics. This can + // be optionally returned. + EvaluationMetricsSet *XPSEvaluationMetricsSet `json:"evaluationMetricsSet,omitempty"` + + // ExplanationConfigs: VisionExplanationConfig for XAI on test set. + // Optional for when XAI is enable in training request. + ExplanationConfigs []*XPSResponseExplanationSpec `json:"explanationConfigs,omitempty"` + + ImageClassificationTrainResp *XPSImageClassificationTrainResponse `json:"imageClassificationTrainResp,omitempty"` + + ImageObjectDetectionTrainResp *XPSImageObjectDetectionModelSpec `json:"imageObjectDetectionTrainResp,omitempty"` + + ImageSegmentationTrainResp *XPSImageSegmentationTrainResponse `json:"imageSegmentationTrainResp,omitempty"` + + // ModelToken: Token that represents the trained model. This is + // considered immutable and is persisted in AutoML. xPS can put their + // own proto in the byte string, to e.g. point to the model checkpoints. + // The token is passed to other xPS APIs to refer to the model. + ModelToken string `json:"modelToken,omitempty"` + + SpeechTrainResp *XPSSpeechModelSpec `json:"speechTrainResp,omitempty"` + + TablesTrainResp *XPSTablesTrainResponse `json:"tablesTrainResp,omitempty"` + + TextToSpeechTrainResp *XPSTextToSpeechTrainResponse `json:"textToSpeechTrainResp,omitempty"` + + // TextTrainResp: Will only be needed for uCAIP from Beta. + TextTrainResp *XPSTextTrainResponse `json:"textTrainResp,omitempty"` + + TranslationTrainResp *XPSTranslationTrainResponse `json:"translationTrainResp,omitempty"` + + VideoActionRecognitionTrainResp *XPSVideoActionRecognitionTrainResponse `json:"videoActionRecognitionTrainResp,omitempty"` + + VideoClassificationTrainResp *XPSVideoClassificationTrainResponse `json:"videoClassificationTrainResp,omitempty"` + + VideoObjectTrackingTrainResp *XPSVideoObjectTrackingTrainResponse `json:"videoObjectTrackingTrainResp,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DeployedModelSizeBytes") 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. "DeployedModelSizeBytes") + // 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 *XPSTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSTrainingObjectivePoint struct { + // CreateTime: The time at which this point was recorded. + CreateTime string `json:"createTime,omitempty"` + + // Value: The objective value when this point was recorded. + Value float64 `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *XPSTrainingObjectivePoint) MarshalJSON() ([]byte, error) { + type NoMethod XPSTrainingObjectivePoint + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTrainingObjectivePoint) UnmarshalJSON(data []byte) error { + type NoMethod XPSTrainingObjectivePoint + 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 +} + +// XPSTranslationEvaluationMetrics: Evaluation metrics for the dataset. +type XPSTranslationEvaluationMetrics struct { + // BaseBleuScore: BLEU score for base model. + BaseBleuScore float64 `json:"baseBleuScore,omitempty"` + + // BleuScore: BLEU score. + BleuScore float64 `json:"bleuScore,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BaseBleuScore") 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. "BaseBleuScore") 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 *XPSTranslationEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSTranslationEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSTranslationEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSTranslationEvaluationMetrics + var s1 struct { + BaseBleuScore gensupport.JSONFloat64 `json:"baseBleuScore"` + BleuScore gensupport.JSONFloat64 `json:"bleuScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BaseBleuScore = float64(s1.BaseBleuScore) + s.BleuScore = float64(s1.BleuScore) + return nil +} + +// XPSTranslationPreprocessResponse: Translation preprocess response. +type XPSTranslationPreprocessResponse struct { + // ParsedExampleCount: Total example count parsed. + ParsedExampleCount int64 `json:"parsedExampleCount,omitempty,string"` + + // ValidExampleCount: Total valid example count. + ValidExampleCount int64 `json:"validExampleCount,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ParsedExampleCount") + // 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. "ParsedExampleCount") 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 *XPSTranslationPreprocessResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTranslationPreprocessResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTranslationTrainResponse: Train response for translation. +type XPSTranslationTrainResponse struct { + // ModelType: Type of the model. + // + // Possible values: + // "MODEL_TYPE_UNSPECIFIED" - Default + // "LEGACY" - Legacy model. Will be deprecated. + // "CURRENT" - Current model. + ModelType string `json:"modelType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ModelType") 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. "ModelType") 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 *XPSTranslationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSTranslationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSTuningTrial: Metrics for a tuning job generated, will get +// forwarded to Stackdriver as model tuning logs. Setting this as a +// standalone message out of CreateModelMetadata to avoid confusion as +// we expose this message only to users. +type XPSTuningTrial struct { + // ModelStructure: Model parameters for the trial. + ModelStructure *XPSTablesModelStructure `json:"modelStructure,omitempty"` + + // TrainingObjectivePoint: The optimization objective evaluation of the + // eval split data. + TrainingObjectivePoint *XPSTrainingObjectivePoint `json:"trainingObjectivePoint,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ModelStructure") 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. "ModelStructure") 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 *XPSTuningTrial) MarshalJSON() ([]byte, error) { + type NoMethod XPSTuningTrial + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVideoActionMetricsEntry: The Evaluation metrics entry given a +// specific precision_window_length. +type XPSVideoActionMetricsEntry struct { + // ConfidenceMetricsEntries: Metrics for each label-match + // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + ConfidenceMetricsEntries []*XPSVideoActionMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` + + // MeanAveragePrecision: The mean average precision. + MeanAveragePrecision float64 `json:"meanAveragePrecision,omitempty"` + + // PrecisionWindowLength: This VideoActionMetricsEntry is calculated + // based on this prediction window length. If the predicted action's + // timestamp is inside the time window whose center is the ground truth + // action's timestamp with this specific length, the prediction result + // is treated as a true positive. + PrecisionWindowLength string `json:"precisionWindowLength,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ConfidenceMetricsEntries") 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. "ConfidenceMetricsEntries") + // 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 *XPSVideoActionMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVideoActionMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSVideoActionMetricsEntry + var s1 struct { + MeanAveragePrecision gensupport.JSONFloat64 `json:"meanAveragePrecision"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.MeanAveragePrecision = float64(s1.MeanAveragePrecision) + return nil +} + +// XPSVideoActionMetricsEntryConfidenceMetricsEntry: Metrics for a +// single confidence threshold. +type XPSVideoActionMetricsEntryConfidenceMetricsEntry struct { + // ConfidenceThreshold: Output only. The confidence threshold value used + // to compute the metrics. + ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` + + // F1Score: Output only. The harmonic mean of recall and precision. + F1Score float64 `json:"f1Score,omitempty"` + + // Precision: Output only. Precision for the given confidence threshold. + Precision float64 `json:"precision,omitempty"` + + // Recall: Output only. Recall for the given confidence threshold. + Recall float64 `json:"recall,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") + // 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. "ConfidenceThreshold") 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 *XPSVideoActionMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionMetricsEntryConfidenceMetricsEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVideoActionMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { + type NoMethod XPSVideoActionMetricsEntryConfidenceMetricsEntry + var s1 struct { + ConfidenceThreshold gensupport.JSONFloat64 `json:"confidenceThreshold"` + F1Score gensupport.JSONFloat64 `json:"f1Score"` + Precision gensupport.JSONFloat64 `json:"precision"` + Recall gensupport.JSONFloat64 `json:"recall"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ConfidenceThreshold = float64(s1.ConfidenceThreshold) + s.F1Score = float64(s1.F1Score) + s.Precision = float64(s1.Precision) + s.Recall = float64(s1.Recall) + return nil +} + +// XPSVideoActionRecognitionEvaluationMetrics: Model evaluation metrics +// for video action recognition. +type XPSVideoActionRecognitionEvaluationMetrics struct { + // EvaluatedActionCount: Output only. The number of ground truth actions + // used to create this evaluation. + EvaluatedActionCount int64 `json:"evaluatedActionCount,omitempty"` + + // VideoActionMetricsEntries: Output only. The metric entries for + // precision window lengths: 1s,2s,3s,4s, 5s. + VideoActionMetricsEntries []*XPSVideoActionMetricsEntry `json:"videoActionMetricsEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "EvaluatedActionCount") 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. "EvaluatedActionCount") 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 *XPSVideoActionRecognitionEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionRecognitionEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoActionRecognitionTrainResponse struct { + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ModelArtifactSpec") + // 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. "ModelArtifactSpec") 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 *XPSVideoActionRecognitionTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoActionRecognitionTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoBatchPredictOperationMetadata struct { + // OutputExamples: All the partial batch prediction results that are + // completed at the moment. Output examples are sorted by completion + // time. The order will not be changed. Each output example should be + // the path of a single RecordIO file of AnnotatedExamples. + OutputExamples []string `json:"outputExamples,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OutputExamples") 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. "OutputExamples") 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 *XPSVideoBatchPredictOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoBatchPredictOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoClassificationTrainResponse struct { + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ModelArtifactSpec") + // 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. "ModelArtifactSpec") 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 *XPSVideoClassificationTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoClassificationTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVideoExportModelSpec: Information of downloadable models that are +// pre-generated as part of training flow and will be persisted in +// AutoMl backend. Upon receiving ExportModel request from user, AutoMl +// backend can serve the pre-generated models to user if exists (by +// copying the files from internal path to user provided location), +// otherwise, AutoMl backend will call xPS ExportModel API to generate +// the model on the fly with the requesting format. +type XPSVideoExportModelSpec struct { + // ExportModelOutputConfig: Contains the model format and internal + // location of the model files to be exported/downloaded. Use the GCS + // bucket name which is provided via TrainRequest.gcs_bucket_name to + // store the model files. + ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ExportModelOutputConfig") 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. "ExportModelOutputConfig") + // 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 *XPSVideoExportModelSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoExportModelSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoModelArtifactSpec struct { + // ExportArtifact: The model binary files in different formats for model + // export. + ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` + + // ServingArtifact: The default model binary file used for serving (e.g. + // batch predict) via public Cloud AI Platform API. + ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExportArtifact") 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. "ExportArtifact") 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 *XPSVideoModelArtifactSpec) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoModelArtifactSpec + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVideoObjectTrackingEvaluationMetrics: Model evaluation metrics for +// ObjectTracking problems. Next tag: 10. +type XPSVideoObjectTrackingEvaluationMetrics struct { + // BoundingBoxMeanAveragePrecision: Output only. The single metric for + // bounding boxes evaluation: the mean_average_precision averaged over + // all bounding_box_metrics_entries. + BoundingBoxMeanAveragePrecision float64 `json:"boundingBoxMeanAveragePrecision,omitempty"` + + // BoundingBoxMetricsEntries: Output only. The bounding boxes match + // metrics for each Intersection-over-union threshold + // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + BoundingBoxMetricsEntries []*XPSBoundingBoxMetricsEntry `json:"boundingBoxMetricsEntries,omitempty"` + + // EvaluatedBoundingboxCount: The number of bounding boxes used for + // model evaluation. + EvaluatedBoundingboxCount int64 `json:"evaluatedBoundingboxCount,omitempty"` + + // EvaluatedFrameCount: The number of video frames used for model + // evaluation. + EvaluatedFrameCount int64 `json:"evaluatedFrameCount,omitempty"` + + // EvaluatedTrackCount: The number of tracks used for model evaluation. + EvaluatedTrackCount int64 `json:"evaluatedTrackCount,omitempty"` + + // TrackMeanAveragePrecision: Output only. The single metric for tracks + // accuracy evaluation: the mean_average_precision averaged over all + // track_metrics_entries. + TrackMeanAveragePrecision float64 `json:"trackMeanAveragePrecision,omitempty"` + + // TrackMeanBoundingBoxIou: Output only. The single metric for tracks + // bounding box iou evaluation: the mean_bounding_box_iou averaged over + // all track_metrics_entries. + TrackMeanBoundingBoxIou float64 `json:"trackMeanBoundingBoxIou,omitempty"` + + // TrackMeanMismatchRate: Output only. The single metric for tracking + // consistency evaluation: the mean_mismatch_rate averaged over all + // track_metrics_entries. + TrackMeanMismatchRate float64 `json:"trackMeanMismatchRate,omitempty"` + + // TrackMetricsEntries: Output only. The tracks match metrics for each + // Intersection-over-union threshold + // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + TrackMetricsEntries []*XPSTrackMetricsEntry `json:"trackMetricsEntries,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "BoundingBoxMeanAveragePrecision") 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. + // "BoundingBoxMeanAveragePrecision") 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 *XPSVideoObjectTrackingEvaluationMetrics) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoObjectTrackingEvaluationMetrics + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVideoObjectTrackingEvaluationMetrics) UnmarshalJSON(data []byte) error { + type NoMethod XPSVideoObjectTrackingEvaluationMetrics + var s1 struct { + BoundingBoxMeanAveragePrecision gensupport.JSONFloat64 `json:"boundingBoxMeanAveragePrecision"` + TrackMeanAveragePrecision gensupport.JSONFloat64 `json:"trackMeanAveragePrecision"` + TrackMeanBoundingBoxIou gensupport.JSONFloat64 `json:"trackMeanBoundingBoxIou"` + TrackMeanMismatchRate gensupport.JSONFloat64 `json:"trackMeanMismatchRate"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.BoundingBoxMeanAveragePrecision = float64(s1.BoundingBoxMeanAveragePrecision) + s.TrackMeanAveragePrecision = float64(s1.TrackMeanAveragePrecision) + s.TrackMeanBoundingBoxIou = float64(s1.TrackMeanBoundingBoxIou) + s.TrackMeanMismatchRate = float64(s1.TrackMeanMismatchRate) + return nil +} + +type XPSVideoObjectTrackingTrainResponse struct { + // ExportModelSpec: Populated for AutoML request only. + ExportModelSpec *XPSVideoExportModelSpec `json:"exportModelSpec,omitempty"` + + // ModelArtifactSpec: ## The fields below are only populated under uCAIP + // request scope. + ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` + + // TrainCostNodeSeconds: The actual train cost of creating this model, + // expressed in node seconds, i.e. 3,600 value in this field means 1 + // node hour. + TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "ExportModelSpec") 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. "ExportModelSpec") 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 *XPSVideoObjectTrackingTrainResponse) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoObjectTrackingTrainResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVideoTrainingOperationMetadata struct { + // TrainCostMilliNodeHour: This is an estimation of the node hours + // necessary for training a model, expressed in milli node hours (i.e. + // 1,000 value in this field means 1 node hour). A node hour represents + // the time a virtual machine spends running your training job. The cost + // of one node running for one hour is a node hour. + TrainCostMilliNodeHour int64 `json:"trainCostMilliNodeHour,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. + // "TrainCostMilliNodeHour") 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. "TrainCostMilliNodeHour") + // 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 *XPSVideoTrainingOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSVideoTrainingOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVisionErrorAnalysisConfig: The vision model error analysis +// configuration. Next tag: 3 +type XPSVisionErrorAnalysisConfig struct { + // ExampleCount: The number of query examples in error analysis. + ExampleCount int64 `json:"exampleCount,omitempty"` + + // QueryType: The query type used in retrieval. The enum values are + // frozen in the foreseeable future. + // + // Possible values: + // "QUERY_TYPE_UNSPECIFIED" - Unspecified query type for model error + // analysis. + // "QUERY_TYPE_ALL_SIMILAR" - Query similar samples across all classes + // in the dataset. + // "QUERY_TYPE_SAME_CLASS_SIMILAR" - Query similar samples from the + // same class of the input sample. + // "QUERY_TYPE_SAME_CLASS_DISSIMILAR" - Query dissimilar samples from + // the same class of the input sample. + QueryType string `json:"queryType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExampleCount") 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. "ExampleCount") 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 *XPSVisionErrorAnalysisConfig) MarshalJSON() ([]byte, error) { + type NoMethod XPSVisionErrorAnalysisConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +type XPSVisionTrainingOperationMetadata struct { + // ExplanationUsage: Aggregated infra usage within certain time period, + // for billing report purpose if XAI is enable in training request. + ExplanationUsage *InfraUsage `json:"explanationUsage,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExplanationUsage") 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. "ExplanationUsage") 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 *XPSVisionTrainingOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSVisionTrainingOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSVisualization: Visualization configurations for image explanation. +type XPSVisualization struct { + // ClipPercentLowerbound: Excludes attributions below the specified + // percentile, from the highlighted areas. Defaults to 62. + ClipPercentLowerbound float64 `json:"clipPercentLowerbound,omitempty"` + + // ClipPercentUpperbound: Excludes attributions above the specified + // percentile from the highlighted areas. Using the + // clip_percent_upperbound and clip_percent_lowerbound together can be + // useful for filtering out noise and making it easier to see areas of + // strong attribution. Defaults to 99.9. + ClipPercentUpperbound float64 `json:"clipPercentUpperbound,omitempty"` + + // ColorMap: The color scheme used for the highlighted areas. Defaults + // to PINK_GREEN for Integrated Gradients attribution, which shows + // positive attributions in green and negative in pink. Defaults to + // VIRIDIS for XRAI attribution, which highlights the most influential + // regions in yellow and the least influential in blue. + // + // Possible values: + // "COLOR_MAP_UNSPECIFIED" - Should not be used. + // "PINK_GREEN" - Positive: green. Negative: pink. + // "VIRIDIS" - Viridis color map: A perceptually uniform color mapping + // which is easier to see by those with colorblindness and progresses + // from yellow to green to blue. Positive: yellow. Negative: blue. + // "RED" - Positive: red. Negative: red. + // "GREEN" - Positive: green. Negative: green. + // "RED_GREEN" - Positive: green. Negative: red. + // "PINK_WHITE_GREEN" - PiYG palette. + ColorMap string `json:"colorMap,omitempty"` + + // OverlayType: How the original image is displayed in the + // visualization. Adjusting the overlay can help increase visual clarity + // if the original image makes it difficult to view the visualization. + // Defaults to NONE. + // + // Possible values: + // "OVERLAY_TYPE_UNSPECIFIED" - Default value. This is the same as + // NONE. + // "NONE" - No overlay. + // "ORIGINAL" - The attributions are shown on top of the original + // image. + // "GRAYSCALE" - The attributions are shown on top of grayscaled + // version of the original image. + // "MASK_BLACK" - The attributions are used as a mask to reveal + // predictive parts of the image and hide the un-predictive parts. + OverlayType string `json:"overlayType,omitempty"` + + // Polarity: Whether to only highlight pixels with positive + // contributions, negative or both. Defaults to POSITIVE. + // + // Possible values: + // "POLARITY_UNSPECIFIED" - Default value. This is the same as + // POSITIVE. + // "POSITIVE" - Highlights the pixels/outlines that were most + // influential to the model's prediction. + // "NEGATIVE" - Setting polarity to negative highlights areas that + // does not lead to the models's current prediction. + // "BOTH" - Shows both positive and negative attributions. + Polarity string `json:"polarity,omitempty"` + + // Type: Type of the image visualization. Only applicable to Integrated + // Gradients attribution. OUTLINES shows regions of attribution, while + // PIXELS shows per-pixel attribution. Defaults to OUTLINES. + // + // Possible values: + // "TYPE_UNSPECIFIED" - Should not be used. + // "PIXELS" - Shows which pixel contributed to the image prediction. + // "OUTLINES" - Shows which region contributed to the image prediction + // by outlining the region. + Type string `json:"type,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ClipPercentLowerbound") 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. "ClipPercentLowerbound") 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 *XPSVisualization) MarshalJSON() ([]byte, error) { + type NoMethod XPSVisualization + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *XPSVisualization) UnmarshalJSON(data []byte) error { + type NoMethod XPSVisualization + var s1 struct { + ClipPercentLowerbound gensupport.JSONFloat64 `json:"clipPercentLowerbound"` + ClipPercentUpperbound gensupport.JSONFloat64 `json:"clipPercentUpperbound"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.ClipPercentLowerbound = float64(s1.ClipPercentLowerbound) + s.ClipPercentUpperbound = float64(s1.ClipPercentUpperbound) + return nil +} + +type XPSXpsOperationMetadata struct { + // ExampleCount: Optional. XPS server can opt to provide example count + // of the long running operation (e.g. training, data importing, batch + // prediction). + ExampleCount int64 `json:"exampleCount,omitempty,string"` + + // ReportingMetrics: Metrics for the operation. By the time the + // operation is terminated (whether succeeded or failed) as returned + // from XPS, AutoML BE assumes the metrics are finalized. AutoML BE + // transparently posts the metrics to Chemist if it's not empty, + // regardless of the response content or error type. If user is supposed + // to be charged in case of cancellation/error, this field should be + // set. In the case where the type of LRO doesn't require any billing, + // this field should be left unset. + ReportingMetrics *XPSReportingMetrics `json:"reportingMetrics,omitempty"` + + TablesTrainingOperationMetadata *XPSTablesTrainingOperationMetadata `json:"tablesTrainingOperationMetadata,omitempty"` + + VideoBatchPredictOperationMetadata *XPSVideoBatchPredictOperationMetadata `json:"videoBatchPredictOperationMetadata,omitempty"` + + VideoTrainingOperationMetadata *XPSVideoTrainingOperationMetadata `json:"videoTrainingOperationMetadata,omitempty"` + + VisionTrainingOperationMetadata *XPSVisionTrainingOperationMetadata `json:"visionTrainingOperationMetadata,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ExampleCount") 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. "ExampleCount") 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 *XPSXpsOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod XPSXpsOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// XPSXraiAttribution: An explanation method that redistributes +// Integrated Gradients attributions to segmented regions, taking +// advantage of the model's fully differentiable structure. Refer to +// this paper for more details: https://arxiv.org/abs/1906.02825 Only +// supports image Models (modality is IMAGE). +type XPSXraiAttribution struct { + // StepCount: The number of steps for approximating the path integral. A + // good value to start is 50 and gradually increase until the sum to + // diff property is met within the desired error range. Valid range of + // its value is [1, 100], inclusively. + StepCount int64 `json:"stepCount,omitempty"` + + // ForceSendFields is a list of field names (e.g. "StepCount") 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. "StepCount") 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 *XPSXraiAttribution) MarshalJSON() ([]byte, error) { + type NoMethod XPSXraiAttribution + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // method id "language.documents.analyzeEntities": type DocumentsAnalyzeEntitiesCall struct { diff --git a/sasportal/v1alpha1/sasportal-api.json b/sasportal/v1alpha1/sasportal-api.json index 0b594deda89..088e1c59983 100644 --- a/sasportal/v1alpha1/sasportal-api.json +++ b/sasportal/v1alpha1/sasportal-api.json @@ -2652,7 +2652,7 @@ } } }, - "revision": "20240201", + "revision": "20240220", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2798,7 +2798,7 @@ "type": "string" }, "fccId": { - "description": "The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format.", + "description": "The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.", "type": "string" }, "grantRangeAllowlists": { diff --git a/sasportal/v1alpha1/sasportal-gen.go b/sasportal/v1alpha1/sasportal-gen.go index aef22b7f205..bb986a45ea9 100644 --- a/sasportal/v1alpha1/sasportal-gen.go +++ b/sasportal/v1alpha1/sasportal-gen.go @@ -646,7 +646,8 @@ type SasPortalDevice struct { DisplayName string `json:"displayName,omitempty"` // FccId: The FCC identifier of the device. Refer to - // https://www.fcc.gov/oet/ea/fccid for FccID format. + // https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores + // and periods because some test-SAS customers use them. FccId string `json:"fccId,omitempty"` // GrantRangeAllowlists: Only ranges that are within the allowlists are