diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index 88f22cf45f0..f59c1ff27ca 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -298,7 +298,7 @@ ] }, "testIamPermissions": { - "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.", + "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. **IAM Permissions**: No specific IAM permission is required to call this method. It returns the subset of the requested permissions that the caller possesses.", "flatPath": "v1/accessPolicies/{accessPoliciesId}:testIamPermissions", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.testIamPermissions", @@ -536,7 +536,7 @@ ] }, "testIamPermissions": { - "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.", + "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. **IAM Permissions**: No specific IAM permission is required to call this method. It returns the subset of the requested permissions that the caller possesses.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}:testIamPermissions", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.accessLevels.testIamPermissions", @@ -924,7 +924,7 @@ ] }, "testIamPermissions": { - "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.", + "description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. **IAM Permissions**: No specific IAM permission is required to call this method. It returns the subset of the requested permissions that the caller possesses.", "flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}:testIamPermissions", "httpMethod": "POST", "id": "accesscontextmanager.accessPolicies.servicePerimeters.testIamPermissions", @@ -1278,7 +1278,7 @@ "services": { "methods": { "get": { - "description": "Returns a VPC-SC supported service based on the service name.", + "description": "Returns a VPC-SC supported service based on the service name. **IAM Permissions**: Requires the following IAM permissions to use this method: - `serviceusage.services.use` on the project.", "flatPath": "v1/services/{name}", "httpMethod": "GET", "id": "accesscontextmanager.services.get", @@ -1302,7 +1302,7 @@ ] }, "list": { - "description": "Lists all VPC-SC supported services.", + "description": "Lists all VPC-SC supported services. **IAM Permissions**: Requires the following IAM permissions to use this method: - `serviceusage.services.use` on the project.", "flatPath": "v1/services", "httpMethod": "GET", "id": "accesscontextmanager.services.list", @@ -1331,7 +1331,7 @@ } } }, - "revision": "20260426", + "revision": "20260506", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 1a5bb182641..375054616fe 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -22213,6 +22213,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "cancelAsyncQuery": { + "description": "Cancels an AsyncQueryReasoningEngine operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:cancelAsyncQuery", + "response": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a reasoning engine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", @@ -29006,6 +29036,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "cancelAsyncQuery": { + "description": "Cancels an AsyncQueryReasoningEngine operation.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.cancelAsyncQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:cancelAsyncQuery", + "response": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a reasoning engine.", "flatPath": "v1/reasoningEngines", @@ -32301,7 +32361,7 @@ } } }, - "revision": "20260427", + "revision": "20260506", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -34633,6 +34693,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse": { + "description": "Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest": { "description": "Request message for JobService.CancelBatchPredictionJob.", "id": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest", @@ -54296,7 +54362,7 @@ "type": "string" }, "pythonVersion": { - "description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.", + "description": "Optional. The Python version. Supported values are 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -54436,7 +54502,7 @@ "type": "string" }, "version": { - "description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", + "description": "Optional. The version of Python to use. Supported versions include 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", "type": "string" } }, @@ -55667,11 +55733,6 @@ "readOnly": true, "type": "string" }, - "sandboxHostname": { - "description": "Output only. The hostname of the SandboxEnvironment.", - "readOnly": true, - "type": "string" - }, "sandboxInternalIp": { "description": "Output only. The internal IP address of the SandboxEnvironment.", "readOnly": true, diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 164043fb653..909588b12f8 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -28834,6 +28834,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "cancelAsyncQuery": { + "description": "Cancels an AsyncQueryReasoningEngine operation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancelAsyncQuery", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a reasoning engine.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", @@ -38828,6 +38858,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "cancelAsyncQuery": { + "description": "Cancels an AsyncQueryReasoningEngine operation.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.cancelAsyncQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancelAsyncQuery", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a reasoning engine.", "flatPath": "v1beta1/reasoningEngines", @@ -45463,7 +45523,7 @@ } } }, - "revision": "20260427", + "revision": "20260506", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -48259,6 +48319,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse": { + "description": "Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest": { "description": "Request message for JobService.CancelBatchPredictionJob.", "id": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest", @@ -72220,7 +72286,7 @@ "type": "string" }, "pythonVersion": { - "description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.", + "description": "Optional. The Python version. Supported values are 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -72360,7 +72426,7 @@ "type": "string" }, "version": { - "description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", + "description": "Optional. The version of Python to use. Supported versions include 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", "type": "string" } }, @@ -74048,11 +74114,6 @@ "readOnly": true, "type": "string" }, - "sandboxHostname": { - "description": "Output only. The hostname of the SandboxEnvironment.", - "readOnly": true, - "type": "string" - }, "sandboxInternalIp": { "description": "Output only. The internal IP address of the SandboxEnvironment.", "readOnly": true, diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 236897d4589..298a729ac7e 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1265,7 +1265,7 @@ } } }, - "revision": "20260408", + "revision": "20260507", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -6116,6 +6116,20 @@ "description": "Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored.", "type": "boolean" }, + "autofillPolicy": { + "description": "Optional. The policy for the autofill service.", + "enum": [ + "AUTOFILL_POLICY_UNSPECIFIED", + "AUTOFILL_USER_CHOICE", + "AUTOFILL_DISABLED" + ], + "enumDescriptions": [ + "Defaults to AUTOFILL_USER_CHOICE.", + "The user can choose and use an autofill service.", + "Autofill is disabled and the user is not allowed to change this setting. This is supported only on Android 8 and above." + ], + "type": "string" + }, "blockApplicationsEnabled": { "deprecated": true, "description": "This field has no effect.", diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 60bd30895c2..1437bc99496 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -5637,7 +5637,7 @@ } } }, - "revision": "20260506", + "revision": "20260511", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6308,7 +6308,7 @@ }, "recurringPrice": { "$ref": "Money", - "description": "The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed." + "description": "The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes. For tax-exclusive pricing, please call orders.get API instead if transaction details are needed." } }, "type": "object" diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 99e8245842c..6385784b0df 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -1123,7 +1123,7 @@ ] }, "update": { - "description": "Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.", + "description": "Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names. **Note:** We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.", "flatPath": "v1/organizations/{organizationsId}/apiproducts/{apiproductsId}", "httpMethod": "PUT", "id": "apigee.organizations.apiproducts.update", @@ -2260,7 +2260,7 @@ ] }, "update": { - "description": "Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup.", + "description": "Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. **Note:** We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.", "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}", "httpMethod": "PUT", "id": "apigee.organizations.appgroups.update", @@ -2293,7 +2293,7 @@ ] }, "updateMonetizationConfig": { - "description": "Updates the monetization configuration for the AppGroup.", + "description": "Updates the monetization configuration for the AppGroup. **Note:** We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.", "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/monetizationConfig", "httpMethod": "PUT", "id": "apigee.organizations.appgroups.updateMonetizationConfig", @@ -2439,7 +2439,7 @@ ] }, "update": { - "description": "Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.", + "description": "Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. **Note:** We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.", "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}", "httpMethod": "PUT", "id": "apigee.organizations.appgroups.apps.update", @@ -3386,7 +3386,7 @@ ] }, "update": { - "description": "Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", + "description": "Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. **Note:** We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}", "httpMethod": "PUT", "id": "apigee.organizations.developers.update", @@ -3641,7 +3641,7 @@ ] }, "update": { - "description": "Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.", + "description": "Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. **Note:** We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}", "httpMethod": "PUT", "id": "apigee.organizations.developers.apps.update", @@ -11964,7 +11964,7 @@ } } }, - "revision": "20260327", + "revision": "20260430", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index 46abda55fc7..c9da067bd62 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -2661,7 +2661,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -6465,6 +6465,58 @@ }, "type": "object" }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "additionalInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. AdditionalInfo contains additional Info related to backup plan association resource.", + "readOnly": true, + "type": "object" + }, + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PitrSettings": { "description": "Point in time recovery settings of the backup configuration resource.", "id": "PitrSettings", @@ -6919,7 +6971,7 @@ "type": "array" }, "hourlyFrequency": { - "description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).", + "description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.", "format": "int32", "type": "integer" }, diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 4a493f05ebb..e985bfc624f 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -600,7 +600,7 @@ } } }, - "revision": "20260417", + "revision": "20260429", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index db725107ace..cd25c522fd7 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -271,7 +271,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "beyondcorp.projects.locations.list", @@ -280,7 +280,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1909,7 +1909,7 @@ } } }, - "revision": "20260401", + "revision": "20260429", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index d5f2ec0753d..328ac504345 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -673,7 +673,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1alpha/projects/{projectsId}/locations", "httpMethod": "GET", "id": "beyondcorp.projects.locations.list", @@ -682,7 +682,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3332,7 +3332,7 @@ } } }, - "revision": "20260401", + "revision": "20260429", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 9fae3ce49c7..8876bdc938f 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -343,7 +343,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`", + "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -361,7 +361,7 @@ ] }, "update": { - "description": "Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl", + "description": "Updates a course. Note: Unlike other fields, `levels` is not cleared if omitted from the request. The `UpdateCourse` method only modifies `levels` if it is explicitly provided; otherwise, the existing value is preserved. Use the `PatchCourse` method to clear the `levels` field. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl", "flatPath": "v1/courses/{id}", "httpMethod": "PUT", "id": "classroom.courses.update", @@ -1651,6 +1651,11 @@ "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher", + "https://www.googleapis.com/auth/classroom.coursework.me", + "https://www.googleapis.com/auth/classroom.coursework.me.readonly", + "https://www.googleapis.com/auth/classroom.coursework.students", + "https://www.googleapis.com/auth/classroom.coursework.students.readonly", + "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly", "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ] }, @@ -3107,6 +3112,11 @@ "scopes": [ "https://www.googleapis.com/auth/classroom.addons.student", "https://www.googleapis.com/auth/classroom.addons.teacher", + "https://www.googleapis.com/auth/classroom.coursework.me", + "https://www.googleapis.com/auth/classroom.coursework.me.readonly", + "https://www.googleapis.com/auth/classroom.coursework.students", + "https://www.googleapis.com/auth/classroom.coursework.students.readonly", + "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly", "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ] }, @@ -4366,7 +4376,7 @@ } } }, - "revision": "20260414", + "revision": "20260505", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -4737,6 +4747,10 @@ "description": "Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.", "type": "string" }, + "levels": { + "description": "Optional. Levels for the course. Examples: \"9th grade\", \"Middle school\", \"4th - 5th\", \"K-2\", \"3000\". If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the `PatchCourse` method.", + "type": "string" + }, "name": { "description": "Name of the course. For example, \"10th Grade Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.", "type": "string" diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index f0452b92270..b663edb7caa 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -2359,7 +2359,7 @@ } } }, - "revision": "20260422", + "revision": "20260427", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -3439,6 +3439,10 @@ "image": { "description": "Required. Image is the container image to use.", "type": "string" + }, + "script": { + "description": "Optional. Shell script to execute. If provided then command and args cannot be specified.", + "type": "string" } }, "type": "object" diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index 8b046ccfecd..05215174f93 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -2349,7 +2349,7 @@ } } }, - "revision": "20260317", + "revision": "20260506", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2425,6 +2425,42 @@ }, "type": "object" }, + "AntivirusInfo": { + "description": "Resource representing the anti-virus information of a Device.", + "id": "AntivirusInfo", + "properties": { + "displayName": { + "description": "Output only. The display name of the anti-virus software.", + "readOnly": true, + "type": "string" + }, + "productGuid": { + "description": "Output only. The GUID of the anti-virus product.", + "readOnly": true, + "type": "string" + }, + "productState": { + "description": "Output only. The state of the anti-virus.", + "enum": [ + "PRODUCT_STATE_UNSPECIFIED", + "PRODUCT_STATE_ON", + "PRODUCT_STATE_OFF", + "PRODUCT_STATE_SNOOZED", + "PRODUCT_STATE_EXPIRED" + ], + "enumDescriptions": [ + "Default value", + "The anti-virus is on.", + "The anti-virus is off.", + "The anti-virus is snoozed.", + "The anti-virus is expired." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ApproveDeviceUserRequest": { "description": "Request message for approving the device to access user data.", "id": "ApproveDeviceUserRequest", @@ -3017,6 +3053,14 @@ "description": "Output only. Attributes specific to Android devices.", "readOnly": true }, + "antivirusInfo": { + "description": "Output only. Anti-virus information for the device.", + "items": { + "$ref": "AntivirusInfo" + }, + "readOnly": true, + "type": "array" + }, "assetTag": { "description": "Asset tag of the device.", "type": "string" @@ -3220,6 +3264,23 @@ "readOnly": true, "type": "string" }, + "osFirewallStatus": { + "description": "Output only. OS firewall status of the device.", + "enum": [ + "OS_FIREWALL_STATUS_UNSPECIFIED", + "OS_FIREWALL_STATUS_UNKNOWN", + "OS_FIREWALL_STATUS_ENABLED", + "OS_FIREWALL_STATUS_DISABLED" + ], + "enumDescriptions": [ + "Default value", + "OS firewall status is unknown.", + "OS firewall is enabled.", + "OS firewall is disabled." + ], + "readOnly": true, + "type": "string" + }, "osVersion": { "description": "Output only. OS version of the device. Example: Android 8.1.0.", "readOnly": true, @@ -3274,6 +3335,11 @@ "type": "string" }, "type": "array" + }, + "windowsSpecificDeviceAttributes": { + "$ref": "WindowsSpecificDeviceAttributes", + "description": "Output only. Attributes specific to Windows devices.", + "readOnly": true } }, "type": "object" @@ -5858,6 +5924,48 @@ }, "type": "object" }, + "WindowsSpecificDeviceAttributes": { + "description": "Represents the Windows specific attributes of a Device.", + "id": "WindowsSpecificDeviceAttributes", + "properties": { + "hotfixes": { + "description": "Output only. The hotfixes installed on the device.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "secureBootMode": { + "description": "Output only. Secure boot mode of the device.", + "enum": [ + "SECURE_BOOT_MODE_UNSPECIFIED", + "SECURE_BOOT_MODE_UNKNOWN", + "SECURE_BOOT_MODE_ENABLED", + "SECURE_BOOT_MODE_DISABLED" + ], + "enumDescriptions": [ + "Default value", + "Secure boot mode is unknown.", + "Secure boot mode is enabled.", + "Secure boot mode is disabled." + ], + "readOnly": true, + "type": "string" + }, + "windowsMachineDomain": { + "description": "Output only. The domain of the machine that the user is logged into. This is different from the windows_user_domain as the user could be logged into a domain different from the machine domain.", + "readOnly": true, + "type": "string" + }, + "windowsUserDomain": { + "description": "Output only. The domain of the user account that is logged into the machine.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "WipeDeviceRequest": { "description": "Request message for wiping all data on the device.", "id": "WipeDeviceRequest", diff --git a/discovery/cloudnumberregistry-v1alpha.json b/discovery/cloudnumberregistry-v1alpha.json new file mode 100644 index 00000000000..d4c544c5181 --- /dev/null +++ b/discovery/cloudnumberregistry-v1alpha.json @@ -0,0 +1,2534 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://cloudnumberregistry.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Number Registry", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://docs.cloud.google.com/number-registry/reference/rest", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "cloudnumberregistry:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudnumberregistry.mtls.googleapis.com/", + "name": "cloudnumberregistry", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "flatPath": "v1alpha/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "customRanges": { + "methods": { + "create": { + "description": "Creates a new CustomRange in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.customRanges.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "customRangeId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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": "v1alpha/{+parent}/customRanges", + "request": { + "$ref": "CustomRange" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.customRanges.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "findFreeIpRanges": { + "description": "Finds free IP ranges in a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:findFreeIpRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges", + "parameterOrder": [ + "name" + ], + "parameters": { + "cidrPrefixLength": { + "description": "Required. The prefix length of the free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Required. Name of the CustomRange.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + }, + "rangeCount": { + "description": "Optional. The number of free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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": "v1alpha/{+name}:findFreeIpRanges", + "response": { + "$ref": "FindCustomRangeFreeIpRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "CustomRange" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CustomRanges in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListCustomRangesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/customRanges", + "response": { + "$ref": "ListCustomRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.customRanges.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. name of resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "CustomRange" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showUtilization": { + "description": "Gets the details of a single CustomRange and its utilization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:showUtilization", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.showUtilization", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:showUtilization", + "response": { + "$ref": "ShowCustomRangeUtilizationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "discoveredRanges": { + "methods": { + "findFreeIpRanges": { + "description": "Finds free IP ranges in a single DiscoveredRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:findFreeIpRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges", + "parameterOrder": [ + "name" + ], + "parameters": { + "cidrPrefixLength": { + "description": "Required. The prefix length of the free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Required. Name of the DiscoveredRange.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", + "required": true, + "type": "string" + }, + "rangeCount": { + "description": "Optional. The number of free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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": "v1alpha/{+name}:findFreeIpRanges", + "response": { + "$ref": "FindDiscoveredRangeFreeIpRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single DiscoveredRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "DiscoveredRange" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DiscoveredRanges in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListDiscoveredRangesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/discoveredRanges", + "response": { + "$ref": "ListDiscoveredRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showUtilization": { + "description": "Gets the details of a single DiscoveredRange and its utilization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:showUtilization", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.showUtilization", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:showUtilization", + "response": { + "$ref": "ShowDiscoveredRangeUtilizationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ipamAdminScopes": { + "methods": { + "checkAvailability": { + "description": "Checks the availability of IPAM admin scopes in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes:checkAvailability", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent value for the IpamAdminScopes.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "scopes": { + "description": "Required. The scopes of the IpamAdminScopes to look for.", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/ipamAdminScopes:checkAvailability", + "response": { + "$ref": "CheckAvailabilityIpamAdminScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cleanup": { + "description": "Cleans up a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:cleanup", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cleanup", + "request": { + "$ref": "CleanupIpamAdminScopeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new IpamAdminScope in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "ipamAdminScopeId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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": "v1alpha/{+parent}/ipamAdminScopes", + "request": { + "$ref": "IpamAdminScope" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disables a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:disable", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:disable", + "request": { + "$ref": "DisableIpamAdminScopeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "IpamAdminScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all IPAM admin scopes in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListIpamAdminScopesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/ipamAdminScopes", + "response": { + "$ref": "ListIpamAdminScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. name of resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "IpamAdminScope" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "realms": { + "methods": { + "create": { + "description": "Creates a new Realm in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.realms.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "realmId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/realms", + "request": { + "$ref": "Realm" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Realm.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.realms.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes after the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Realm.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.realms.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the Realm.", + "enum": [ + "REALM_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the Realm." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Realm" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Realms in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.realms.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListRealmsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the Realm.", + "enum": [ + "REALM_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the Realm." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/realms", + "response": { + "$ref": "ListRealmsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Realm.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.realms.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Unique name/ID of the realm", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "Realm" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "registryBooks": { + "methods": { + "create": { + "description": "Creates a new RegistryBook in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.registryBooks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "registryBookId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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": "v1alpha/{+parent}/registryBooks", + "request": { + "$ref": "RegistryBook" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.registryBooks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.registryBooks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the RegistryBook.", + "enum": [ + "REGISTRY_BOOK_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the RegistryBook." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "RegistryBook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RegistryBooks in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.registryBooks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListRegistryBooksRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the RegistryBook.", + "enum": [ + "REGISTRY_BOOK_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the RegistryBook." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/registryBooks", + "response": { + "$ref": "ListRegistryBooksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.registryBooks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. name of resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "RegistryBook" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchIpResources": { + "description": "Searches IP resources in a given RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}:searchIpResources", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.registryBooks.searchIpResources", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RegistryBook to search in.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:searchIpResources", + "request": { + "$ref": "SearchIpResourcesRequest" + }, + "response": { + "$ref": "SearchIpResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20260506", + "rootUrl": "https://cloudnumberregistry.googleapis.com/", + "schemas": { + "AggregatedData": { + "description": "Aggregated data for the RegistryBook.", + "id": "AggregatedData", + "properties": { + "customRangesCount": { + "description": "Output only. Number of custom ranges in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "customRealmsCount": { + "description": "Output only. Number of custom realms in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "discoveredRangesCount": { + "description": "Output only. Number of discovered ranges in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "discoveredRealmsCount": { + "description": "Output only. Number of discovered realms in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "uniqueScopesCount": { + "description": "Output only. Number of scopes unique to the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "Attribute": { + "description": "Message describing Attribute object", + "id": "Attribute", + "properties": { + "key": { + "description": "Required. Key of attribute", + "type": "string" + }, + "value": { + "description": "Required. Value of attribute", + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CheckAvailabilityIpamAdminScopesResponse": { + "description": "Message for response to checking the availability of IpamAdminScopes", + "id": "CheckAvailabilityIpamAdminScopesResponse", + "properties": { + "scopeAvailabilities": { + "description": "The details of the requested scopes.", + "items": { + "$ref": "IpamAdminScopeAvailability" + }, + "type": "array" + } + }, + "type": "object" + }, + "CleanupIpamAdminScopeRequest": { + "description": "Message for cleaning up a IpamAdminScope", + "id": "CleanupIpamAdminScopeRequest", + "properties": { + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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).", + "type": "string" + } + }, + "type": "object" + }, + "CustomRange": { + "description": "Message describing CustomRange object", + "id": "CustomRange", + "properties": { + "attributes": { + "description": "Optional. The attributes of the CustomRange.", + "items": { + "$ref": "Attribute" + }, + "type": "array" + }, + "description": { + "description": "Optional. Description of the CustomRange.", + "type": "string" + }, + "ipv4CidrRange": { + "description": "Optional. The IPv4 CIDR range of the CustomRange.", + "type": "string" + }, + "ipv6CidrRange": { + "description": "Optional. The IPv6 CIDR range of the CustomRange.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. name of resource", + "type": "string" + }, + "parentRange": { + "description": "Optional. The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project}/locations/{location}/customRanges/{custom_range}", + "type": "string" + }, + "realm": { + "description": "Optional. The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project}/locations/{location}/realms/{realm}", + "type": "string" + }, + "registryBook": { + "description": "Output only. The registry book of the CustomRange. This field is inherited from the realm or parent range depending on which one is specified.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DisableIpamAdminScopeRequest": { + "description": "Message for disabling a IpamAdminScope", + "id": "DisableIpamAdminScopeRequest", + "properties": { + "requestId": { + "description": "Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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).", + "type": "string" + } + }, + "type": "object" + }, + "DiscoveredRange": { + "description": "Message describing DiscoveredRange object", + "id": "DiscoveredRange", + "properties": { + "attributes": { + "description": "Optional. The attributes of the DiscoveredRange.", + "items": { + "$ref": "Attribute" + }, + "type": "array" + }, + "childCidrOverlapAllowed": { + "description": "Output only. If true, allow child ranges of this range to overlap with each other.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the DiscoveredRange.", + "type": "string" + }, + "discoveryMetadata": { + "$ref": "DiscoveryMetadata", + "description": "Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time.", + "readOnly": true + }, + "ipv4CidrRange": { + "description": "Optional. The IPv4 CIDR range of the DiscoveredRange.", + "type": "string" + }, + "ipv6CidrRange": { + "description": "Optional. The IPv6 CIDR range of the DiscoveredRange.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. Name of the DiscoveredRange.", + "type": "string" + }, + "parentRange": { + "description": "Optional. The parent range of the DiscoveredRange.", + "type": "string" + }, + "realm": { + "description": "Optional. The realm of the DiscoveredRange.", + "type": "string" + }, + "registryBook": { + "description": "Output only. The registry book of the DiscoveredRange.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DiscoveryMetadata": { + "description": "Discovery metadata of the discovered resource.", + "id": "DiscoveryMetadata", + "properties": { + "createTime": { + "description": "Output only. The time when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "eventTime": { + "description": "Output only. The time when the event happened.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Output only. The resource name of the discovered resource, should be API-agnostic. Example: \"projects/{project_number}/networks/{network_id}\".", + "readOnly": true, + "type": "string" + }, + "resourceUri": { + "description": "Output only. The resource uri of the discovered resource.", + "readOnly": true, + "type": "string" + }, + "sourceId": { + "description": "Output only. The canonical google.aip.dev/122 name of the source resource.", + "readOnly": true, + "type": "string" + }, + "sourceSubId": { + "description": "Output only. A single source resource can be the source of multiple CNR resources. This sub_id is used to distinguish between the different CNR resources derived from the same upstream resource. For example, a single subnetwork can be the source of multiple ranges, one for each protocol. In this case, the sub_id could be \"private-ipv4\" or \"private-ipv6\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the resource.", + "enum": [ + "RESOURCE_STATE_UNSPECIFIED", + "INVALID", + "EXISTS", + "DOES_NOT_EXIST", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified state.", + "The resource is in an invalid state.", + "The resource exists in the backing store (is not tombstoned or completely missing) and there were no failures reading out the resource level metadata.", + "Resource does not exist or has been deleted or soft-deleted.", + "There was an error reading out the resource level metadata." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "FindCustomRangeFreeIpRangesResponse": { + "description": "Message for the response to finding free IP ranges.", + "id": "FindCustomRangeFreeIpRangesResponse", + "properties": { + "freeIpCidrRanges": { + "description": "Output only. Free IP CIDR ranges found in the CustomRange.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "FindDiscoveredRangeFreeIpRangesResponse": { + "description": "Message for the response to finding free IP ranges.", + "id": "FindDiscoveredRangeFreeIpRangesResponse", + "properties": { + "freeIpCidrRanges": { + "description": "Output only. Free IP CIDR ranges found in the DiscoveredRange.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "IpamAdminScope": { + "description": "Message describing IpamAdminScope object", + "id": "IpamAdminScope", + "properties": { + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enabledAddonPlatforms": { + "description": "Required. Addon platforms that are enabled for this IPAM admin scope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.", + "items": { + "enum": [ + "ADD_ON_PLATFORM_UNSPECIFIED", + "COMPUTE_ENGINE", + "GCE" + ], + "enumDeprecated": [ + false, + false, + true + ], + "enumDescriptions": [ + "Unspecified add-on platform.", + "Google Compute Engine.", + "Deprecated: Use COMPUTE_ENGINE instead." + ], + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. name of resource", + "type": "string" + }, + "scopes": { + "description": "Required. Administrative scopes enabled for IP address discovery and management. For example, \"organizations/1234567890\". Minimum of 1 scope is required. In preview, only one organization scope is allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of resource discovery pipeline.", + "enum": [ + "DISCOVERY_PIPELINE_STATE_UNSPECIFIED", + "INTERNAL_FAILURE", + "FAILED", + "SETUP_IN_PROGRESS", + "READY_FOR_USE", + "DELETING_IN_PROGRESS", + "UPDATING", + "RECOVERING", + "DISABLED", + "DELETION_COMPLETED", + "CLEANUP_IN_PROGRESS", + "READY_FOR_DELETION" + ], + "enumDescriptions": [ + "Unspecified state.", + "Internal failure.", + "Failure.", + "Setup in progress.", + "Ready for use.", + "Deleting in progress.", + "Updating.", + "Recovering.", + "Disabled.", + "Deleting completed.", + "Cleanup in progress.", + "Ready for deletion." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "IpamAdminScopeAvailability": { + "description": "Message for the availability of an IpamAdminScope", + "id": "IpamAdminScopeAvailability", + "properties": { + "adminProject": { + "description": "The admin project of the IpamAdminScope if it exists.", + "format": "int64", + "type": "string" + }, + "availability": { + "description": "The availability of the scope.", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "AVAILABLE", + "UNAVAILABLE" + ], + "enumDescriptions": [ + "Unspecified availability.", + "The scope is available.", + "The scope is not available." + ], + "type": "string" + }, + "scope": { + "description": "The scope of the IpamAdminScope.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomRangesResponse": { + "description": "Message for response to listing CustomRanges", + "id": "ListCustomRangesResponse", + "properties": { + "customRanges": { + "description": "The list of CustomRange", + "items": { + "$ref": "CustomRange" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListDiscoveredRangesResponse": { + "description": "Message for response to listing DiscoveredRanges", + "id": "ListDiscoveredRangesResponse", + "properties": { + "discoveredRanges": { + "description": "The list of DiscoveredRange", + "items": { + "$ref": "DiscoveredRange" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListIpamAdminScopesResponse": { + "description": "Message for response to listing ipamAdminScopes", + "id": "ListIpamAdminScopesResponse", + "properties": { + "ipamAdminScopes": { + "description": "The list of IpamAdminScope", + "items": { + "$ref": "IpamAdminScope" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRealmsResponse": { + "description": "Message for response to listing Realms", + "id": "ListRealmsResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "realms": { + "description": "The list of Realm", + "items": { + "$ref": "Realm" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRegistryBooksResponse": { + "description": "Message for response to listing RegistryBooks", + "id": "ListRegistryBooksResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "registryBooks": { + "description": "The list of RegistryBook", + "items": { + "$ref": "RegistryBook" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Range": { + "description": "Message describing either a CustomRange or a DiscoveredRange.", + "id": "Range", + "properties": { + "customRange": { + "$ref": "CustomRange", + "description": "A custom range." + }, + "discoveredRange": { + "$ref": "DiscoveredRange", + "description": "A discovered range." + }, + "utilization": { + "$ref": "RangeUtilization", + "description": "The utilization of the range." + } + }, + "type": "object" + }, + "RangeUtilization": { + "description": "Message for the utilization of an IP range", + "id": "RangeUtilization", + "properties": { + "totalConsumed": { + "description": "Output only. The total number of IP addresses consumed in the range.", + "readOnly": true, + "type": "string" + }, + "totalProduced": { + "description": "Output only. The total number of IP addresses produced in the range.", + "readOnly": true, + "type": "string" + }, + "usage": { + "description": "Output only. The usage of the range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "Realm": { + "description": "Message describing Realm object", + "id": "Realm", + "properties": { + "aggregatedData": { + "$ref": "RealmAggregatedData", + "description": "Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE.", + "readOnly": true + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "discoveryMetadata": { + "$ref": "DiscoveryMetadata", + "description": "Output only. Discovery metadata of the realm.", + "readOnly": true + }, + "ipVersion": { + "description": "Optional. IP version of the realm.", + "enum": [ + "IP_VERSION_UNSPECIFIED", + "IPV4", + "IPV6" + ], + "enumDescriptions": [ + "Unspecified IP version.", + "IPv4 IP version.", + "IPv6 IP version." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "managementType": { + "description": "Required. Management type of realm.", + "enum": [ + "MANAGEMENT_TYPE_UNSPECIFIED", + "CNR", + "USER" + ], + "enumDescriptions": [ + "Unspecified management type.", + "Managed by Cloud Number Registry.", + "Managed by User." + ], + "type": "string" + }, + "name": { + "description": "Required. Identifier. Unique name/ID of the realm", + "type": "string" + }, + "registryBook": { + "description": "Required. URI of the registry book that claims the realm.", + "type": "string" + }, + "trafficType": { + "description": "Required. Traffic type of realm.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "UNSET", + "INTERNET", + "PRIVATE", + "LINKLOCAL" + ], + "enumDescriptions": [ + "Unspecified traffic type.", + "Unset traffic type.", + "Internet traffic.", + "Private traffic.", + "Linklocal traffic." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RealmAggregatedData": { + "description": "Aggregated data for the Realm.", + "id": "RealmAggregatedData", + "properties": { + "customRangesCount": { + "description": "Output only. Number of custom ranges in the Realm.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "discoveredRangesCount": { + "description": "Output only. Number of discovered ranges in the Realm.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "RegistryBook": { + "description": "Message describing RegistryBook object", + "id": "RegistryBook", + "properties": { + "aggregatedData": { + "$ref": "AggregatedData", + "description": "Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.", + "readOnly": true + }, + "claimedScopes": { + "description": "Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "Output only. Whether the RegistryBook is the default one.", + "readOnly": true, + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. name of resource", + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SearchIpResourcesRequest": { + "description": "Message for searching IP resources", + "id": "SearchIpResourcesRequest", + "properties": { + "orderBy": { + "description": "Optional. Hint for how to order the results", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "type": "string" + }, + "query": { + "description": "Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - `realm`: The realm name to search in. - `ip_address`: The IP address to search for within ranges. - `ip_version`: The IP version to filter by (e.g., \"IPV4\", \"IPV6\"). - `parent_range`: The parent range of the range to search for. - `attribute_text`: The attribute text to search for within ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for realms are: - `ip_version`: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range`", + "type": "string" + }, + "searchResourceTypes": { + "description": "Optional. The type of resources to search for. If not specified, the server will return ranges.", + "items": { + "enum": [ + "SEARCH_RESOURCE_TYPE_UNSPECIFIED", + "RANGES", + "REALMS" + ], + "enumDescriptions": [ + "Unspecified search type.", + "Search for ranges.", + "Search for realms." + ], + "type": "string" + }, + "type": "array" + }, + "showUtilization": { + "description": "Optional. Whether to show the utilization of the ranges in the response.", + "type": "boolean" + } + }, + "type": "object" + }, + "SearchIpResourcesResponse": { + "description": "Message for response to searching IP resources", + "id": "SearchIpResourcesResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "ranges": { + "deprecated": true, + "description": "Deprecated: Use results field instead. The list of ranges matching the search query.", + "items": { + "$ref": "Range" + }, + "type": "array" + }, + "results": { + "description": "The list of results matching the search query.", + "items": { + "$ref": "SearchIpResourcesResult" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SearchIpResourcesResult": { + "description": "A result matching the search query, which can be either a range or a realm.", + "id": "SearchIpResourcesResult", + "properties": { + "range": { + "$ref": "Range", + "description": "A range matching the search query." + }, + "realm": { + "$ref": "Realm", + "description": "A realm matching the search query." + } + }, + "type": "object" + }, + "ShowCustomRangeUtilizationResponse": { + "description": "Message for the response to getting the utilization of a CustomRange", + "id": "ShowCustomRangeUtilizationResponse", + "properties": { + "customRange": { + "$ref": "CustomRange", + "description": "The CustomRange resource." + }, + "rangeUtilization": { + "$ref": "RangeUtilization", + "description": "The utilization of the CustomRange." + } + }, + "type": "object" + }, + "ShowDiscoveredRangeUtilizationResponse": { + "description": "Message for the response to getting the utilization of a DiscoveredRange", + "id": "ShowDiscoveredRangeUtilizationResponse", + "properties": { + "discoveredRange": { + "$ref": "DiscoveredRange", + "description": "The DiscoveredRange resource." + }, + "rangeUtilization": { + "$ref": "RangeUtilization", + "description": "The utilization of the DiscoveredRange." + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Number Registry API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index bd90f4b6464..90b00798ebb 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -55121,7 +55121,7 @@ } } }, - "revision": "20260422", + "revision": "20260427", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -76872,6 +76872,10 @@ }, "type": "array" }, + "minCpuPlatform": { + "description": "Name of the minimum CPU platform to be used by this instance selection.\ne.g. 'Intel Ice Lake'.", + "type": "string" + }, "rank": { "description": "Rank when prioritizing the shape flexibilities.\nThe instance selections with rank are considered\nfirst, in the ascending order of the rank.\nIf not set, defaults to 0.", "format": "int64", diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index 55f9eaafe29..e08ec614fcf 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -1715,7 +1715,7 @@ } } }, - "revision": "20260423", + "revision": "20260505", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -1735,6 +1735,10 @@ }, "type": "array" }, + "maxSeverity": { + "description": "Maximum severity found among findings.", + "type": "string" + }, "skillName": { "description": "Name of the skill that produced this analysis.", "type": "string" @@ -4985,28 +4989,32 @@ "description": "Category of the finding.", "type": "string" }, - "description": { - "description": "Detailed description of the finding.", - "type": "string" - }, - "filePath": { - "description": "Path to the file where the finding was detected.", - "type": "string" + "location": { + "$ref": "FindingLocation", + "description": "Location (path and line) where the finding was detected." }, - "ruleId": { - "description": "Unique identifier of the rule that produced this finding.", + "scanner": { + "description": "Scanner determines which engine (e.g. static, llm) emitted the finding.", "type": "string" }, "severity": { "description": "Severity of the finding.", "type": "string" - }, - "snippet": { - "description": "Code snippet relevant to the finding.", + } + }, + "type": "object" + }, + "FindingLocation": { + "description": "Location details with file path and line number.", + "id": "FindingLocation", + "properties": { + "filePath": { + "description": "Relative path of the file containing the finding.", "type": "string" }, - "title": { - "description": "Title of the finding.", + "lineNumber": { + "description": "Line number (1-based), or 0 if whole File / unknown.", + "format": "int64", "type": "string" } }, diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index ab0a7425f2a..00712c8c55a 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1454,7 +1454,7 @@ } } }, - "revision": "20260423", + "revision": "20260505", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -1474,6 +1474,10 @@ }, "type": "array" }, + "maxSeverity": { + "description": "Optional. Maximum severity found among findings.", + "type": "string" + }, "skillName": { "description": "Optional. Name of the skill that produced this analysis.", "type": "string" @@ -2029,11 +2033,11 @@ "type": "object" }, "CVSS": { - "description": "Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator", + "description": "Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator", "id": "CVSS", "properties": { "attackComplexity": { - "description": "Defined in CVSS v3, CVSS v2", + "description": "Optional. Attack Complexity (AC). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", @@ -2041,15 +2045,29 @@ "ATTACK_COMPLEXITY_MEDIUM" ], "enumDescriptions": [ - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v2" + "Unspecified.", + "Low attack complexity (AC:L). Defined in CVSS v2, v3, v4.", + "High attack complexity (AC:H). Defined in CVSS v2, v3, v4.", + "Medium attack complexity (AC:M). Defined in CVSS v2." + ], + "type": "string" + }, + "attackRequirements": { + "description": "Optional. Attack Requirements (AT). Defined in CVSS v4.", + "enum": [ + "ATTACK_REQUIREMENTS_UNSPECIFIED", + "ATTACK_REQUIREMENTS_NONE", + "ATTACK_REQUIREMENTS_PRESENT" + ], + "enumDescriptions": [ + "Unspecified.", + "No attack requirements (AT:N). Defined in CVSS v4.", + "Attack requirements: Present (AT:P). Defined in CVSS v4." ], "type": "string" }, "attackVector": { - "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2", + "description": "Optional. Attack Vector (AV). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -2058,16 +2076,16 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3" + "Unspecified.", + "Attack Vector: Network (AV:N). Defined in CVSS v2, v3, v4.", + "Attack Vector: Adjacent (AV:A). Defined in CVSS v2, v3, v4.", + "Attack Vector: Local (AV:L). Defined in CVSS v2, v3, v4.", + "Attack Vector: Physical (AV:P). Defined in CVSS v3, v4." ], "type": "string" }, "authentication": { - "description": "Defined in CVSS v2", + "description": "Optional. Authentication (Au). Defined in CVSS v2.", "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", @@ -2075,15 +2093,15 @@ "AUTHENTICATION_NONE" ], "enumDescriptions": [ - "Defined in CVSS v2", - "Defined in CVSS v2", - "Defined in CVSS v2", - "Defined in CVSS v2" + "Unspecified.", + "Multiple authentication required (Au:M). Defined in CVSS v2.", + "Single authentication required (Au:S). Defined in CVSS v2.", + "No authentication required (Au:N). Defined in CVSS v2." ], "type": "string" }, "availabilityImpact": { - "description": "Defined in CVSS v3, CVSS v2", + "description": "Optional. Availability Impact (A). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2093,22 +2111,22 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v2", - "Defined in CVSS v2" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "baseScore": { - "description": "The base score is a function of the base metric scores.", + "description": "Optional. The base score is a function of the base metric scores.", "format": "float", "type": "number" }, "confidentialityImpact": { - "description": "Defined in CVSS v3, CVSS v2", + "description": "Optional. Confidentiality Impact (C). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2118,12 +2136,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v2", - "Defined in CVSS v2" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -2136,7 +2154,7 @@ "type": "number" }, "integrityImpact": { - "description": "Defined in CVSS v3, CVSS v2", + "description": "Optional. Integrity Impact (I). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2146,17 +2164,17 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3, CVSS v2", - "Defined in CVSS v2", - "Defined in CVSS v2" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "privilegesRequired": { - "description": "Defined in CVSS v3", + "description": "Optional. Privileges Required (PR). Defined in CVSS v3, v4.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -2164,38 +2182,162 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3" + "Unspecified.", + "No privileges required (PR:N). Defined in CVSS v3, v4.", + "Low privileges required (PR:L). Defined in CVSS v3, v4.", + "High privileges required (PR:H). Defined in CVSS v3, v4." ], "type": "string" }, "scope": { - "description": "Defined in CVSS v3", + "description": "Optional. Scope (S). Defined in CVSS v3.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3" + "Unspecified.", + "Scope: Unchanged (S:U). Defined in CVSS v3.", + "Scope: Changed (S:C). Defined in CVSS v3." + ], + "type": "string" + }, + "subsequentSystemAvailabilityImpact": { + "description": "Optional. Subsequent System Availability Impact (SA). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "subsequentSystemConfidentialityImpact": { + "description": "Optional. Subsequent System Confidentiality Impact (SC). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "subsequentSystemIntegrityImpact": { + "description": "Optional. Subsequent System Integrity Impact (SI). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "userInteraction": { - "description": "Defined in CVSS v3", + "description": "Optional. User Interaction (UI). Defined in CVSS v3, v4.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", - "USER_INTERACTION_REQUIRED" + "USER_INTERACTION_REQUIRED", + "USER_INTERACTION_PASSIVE", + "USER_INTERACTION_ACTIVE" ], "enumDescriptions": [ - "Defined in CVSS v3", - "Defined in CVSS v3", - "Defined in CVSS v3" + "Unspecified.", + "No user interaction required (UI:N). Defined in CVSS v3, v4.", + "User interaction required (UI:R). Defined in CVSS v3.", + "Passive user interaction (UI:P). Defined in CVSS v4.", + "Active user interaction (UI:A). Defined in CVSS v4." + ], + "type": "string" + }, + "vulnerableSystemAvailabilityImpact": { + "description": "Optional. Vulnerable System Availability Impact (VA). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "vulnerableSystemConfidentialityImpact": { + "description": "Optional. Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "vulnerableSystemIntegrityImpact": { + "description": "Optional. Vulnerable System Integrity Impact (VI). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" } @@ -4787,28 +4929,32 @@ "description": "Optional. Category of the finding.", "type": "string" }, - "description": { - "description": "Optional. Detailed description of the finding.", - "type": "string" - }, - "filePath": { - "description": "Optional. Path to the file where the finding was detected.", - "type": "string" + "location": { + "$ref": "FindingLocation", + "description": "Optional. Location (path and line) where the finding was detected." }, - "ruleId": { - "description": "Optional. Unique identifier of the rule that produced this finding.", + "scanner": { + "description": "Optional. Scanner determines which engine (e.g. static, llm) emitted the finding.", "type": "string" }, "severity": { "description": "Optional. Severity of the finding.", "type": "string" - }, - "snippet": { - "description": "Optional. Code snippet relevant to the finding.", + } + }, + "type": "object" + }, + "FindingLocation": { + "description": "Location details with file path and line number.", + "id": "FindingLocation", + "properties": { + "filePath": { + "description": "Optional. Relative path of the file containing the finding.", "type": "string" }, - "title": { - "description": "Optional. Title of the finding.", + "lineNumber": { + "description": "Optional. Line number (1-based), or 0 if whole File / unknown.", + "format": "int64", "type": "string" } }, @@ -7708,12 +7854,14 @@ "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", - "CVSS_VERSION_3" + "CVSS_VERSION_3", + "CVSS_VERSION_4" ], "enumDescriptions": [ "CVSS Version unspecified.", "CVSS v2.", - "CVSS v3." + "CVSS v3.", + "CVSS v4." ], "readOnly": true, "type": "string" @@ -7833,12 +7981,14 @@ "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", - "CVSS_VERSION_3" + "CVSS_VERSION_3", + "CVSS_VERSION_4" ], "enumDescriptions": [ "CVSS Version unspecified.", "CVSS v2.", - "CVSS v3." + "CVSS v3.", + "CVSS v4." ], "type": "string" }, diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index c639bb908b6..2dcd9bf413a 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -1771,7 +1771,7 @@ } } }, - "revision": "20260423", + "revision": "20260505", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -1791,6 +1791,10 @@ }, "type": "array" }, + "maxSeverity": { + "description": "Maximum severity found among findings.", + "type": "string" + }, "skillName": { "description": "Name of the skill that produced this analysis.", "type": "string" @@ -5104,28 +5108,32 @@ "description": "Category of the finding.", "type": "string" }, - "description": { - "description": "Detailed description of the finding.", - "type": "string" - }, - "filePath": { - "description": "Path to the file where the finding was detected.", - "type": "string" + "location": { + "$ref": "FindingLocation", + "description": "Location (path and line) where the finding was detected." }, - "ruleId": { - "description": "Unique identifier of the rule that produced this finding.", + "scanner": { + "description": "Scanner determines which engine (e.g. static, llm) emitted the finding.", "type": "string" }, "severity": { "description": "Severity of the finding.", "type": "string" - }, - "snippet": { - "description": "Code snippet relevant to the finding.", + } + }, + "type": "object" + }, + "FindingLocation": { + "description": "Location details with file path and line number.", + "id": "FindingLocation", + "properties": { + "filePath": { + "description": "Relative path of the file containing the finding.", "type": "string" }, - "title": { - "description": "Title of the finding.", + "lineNumber": { + "description": "Line number (1-based), or 0 if whole File / unknown.", + "format": "int64", "type": "string" } }, diff --git a/discovery/dataform-v1.json b/discovery/dataform-v1.json index 2ca697ca6ba..0b1625c679a 100644 --- a/discovery/dataform-v1.json +++ b/discovery/dataform-v1.json @@ -381,7 +381,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "dataform.projects.locations.list", @@ -390,7 +390,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1497,7 +1497,7 @@ ], "parameters": { "name": { - "description": "Required. The compilation result's name.", + "description": "Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$", "required": true, @@ -1523,7 +1523,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter for the returned list.", + "description": "Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)", "location": "query", "type": "string" }, @@ -1623,7 +1623,7 @@ "type": "string" }, "releaseConfigId": { - "description": "Required. The ID to use for the release config, which will become the final component of the release config's resource name.", + "description": "Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest)", "location": "query", "type": "string" } @@ -1650,7 +1650,7 @@ ], "parameters": { "name": { - "description": "Required. The release config's name.", + "description": "Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", "required": true, @@ -1676,7 +1676,7 @@ ], "parameters": { "name": { - "description": "Required. The release config's name.", + "description": "Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", "required": true, @@ -1708,7 +1708,7 @@ "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.", + "description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest)", "location": "query", "type": "string" }, @@ -3235,7 +3235,7 @@ } } }, - "revision": "20260409", + "revision": "20260430", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3603,7 +3603,7 @@ "properties": { "actionTarget": { "$ref": "Target", - "description": "Output only. The identifier of the action where this error occurred, if available.", + "description": "Output only. The identifier of the action where this error occurred, if available. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CompilationError)", "readOnly": true }, "message": { @@ -4351,7 +4351,7 @@ "type": "string" }, "unreachable": { - "description": "Locations which could not be reached.", + "description": "Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse)", "items": { "type": "string" }, @@ -4419,7 +4419,7 @@ "type": "array" }, "unreachable": { - "description": "Locations which could not be reached.", + "description": "Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse)", "items": { "type": "string" }, @@ -4705,7 +4705,7 @@ "type": "string" }, "jobId": { - "description": "Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.", + "description": "Output only. The ID of the Gemini Enterprise Agent Platform job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.", "readOnly": true, "type": "string" } @@ -5263,7 +5263,7 @@ "type": "string" }, "internalMetadata": { - "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ReleaseConfig)", "readOnly": true, "type": "string" }, diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index 91bdeef1401..69b9590ff23 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -381,7 +381,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "dataform.projects.locations.list", @@ -390,7 +390,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1503,7 +1503,7 @@ ], "parameters": { "name": { - "description": "Required. The compilation result's name.", + "description": "Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$", "required": true, @@ -1529,7 +1529,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter for the returned list.", + "description": "Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)", "location": "query", "type": "string" }, @@ -1629,7 +1629,7 @@ "type": "string" }, "releaseConfigId": { - "description": "Required. The ID to use for the release config, which will become the final component of the release config's resource name.", + "description": "Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest)", "location": "query", "type": "string" } @@ -1656,7 +1656,7 @@ ], "parameters": { "name": { - "description": "Required. The release config's name.", + "description": "Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", "required": true, @@ -1682,7 +1682,7 @@ ], "parameters": { "name": { - "description": "Required. The release config's name.", + "description": "Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", "required": true, @@ -1714,7 +1714,7 @@ "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.", + "description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest)", "location": "query", "type": "string" }, @@ -3247,7 +3247,7 @@ } } }, - "revision": "20260409", + "revision": "20260430", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3615,7 +3615,7 @@ "properties": { "actionTarget": { "$ref": "Target", - "description": "Output only. The identifier of the action where this error occurred, if available.", + "description": "Output only. The identifier of the action where this error occurred, if available. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CompilationError)", "readOnly": true }, "message": { @@ -4363,7 +4363,7 @@ "type": "string" }, "unreachable": { - "description": "Locations which could not be reached.", + "description": "Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse)", "items": { "type": "string" }, @@ -4431,7 +4431,7 @@ "type": "array" }, "unreachable": { - "description": "Locations which could not be reached.", + "description": "Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse)", "items": { "type": "string" }, @@ -4717,7 +4717,7 @@ "type": "string" }, "jobId": { - "description": "Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.", + "description": "Output only. The ID of the Gemini Enterprise Agent Platform job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.", "readOnly": true, "type": "string" } @@ -5275,7 +5275,7 @@ "type": "string" }, "internalMetadata": { - "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ReleaseConfig)", "readOnly": true, "type": "string" }, diff --git a/discovery/datalineage-v1.json b/discovery/datalineage-v1.json index e30430e5483..743aafea35b 100644 --- a/discovery/datalineage-v1.json +++ b/discovery/datalineage-v1.json @@ -556,6 +556,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "searchLineageStreaming": { + "description": "Retrieves a streaming response of lineage links connected to the requested assets by performing a breadth-first search in the given direction. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them. This method retrieves links from all valid locations provided in the request. This method supports Column-Level Lineage (CLL) along with wildcard support to retrieve all CLL for an Entity FQN. Following permissions are required to retrieve links: * `datalineage.events.get` permission for the project where the link is stored for entity-level lineage. * `datalineage.events.getFields` permission for the project where the link is stored for column-level lineage. This method also returns processes that created the links if explicitly requested by setting [max_process_per_link](google.cloud.datacatalog.lineage.v1.SearchLineageStreamingRequest.limits.max_process_per_link) is non-zero and full process details are requested via `links.processes.process` in the [FieldMask](https://developers.google.com/workspace/docs/api/how-tos/field-masks#read_with_a_field_mask). Permission required to retrieve processes: * `datalineage.processes.get` permission for the project where the process is stored.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchLineageStreaming", + "httpMethod": "POST", + "id": "datalineage.projects.locations.searchLineageStreaming", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project and location to initiate the search from.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:searchLineageStreaming", + "request": { + "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequest" + }, + "response": { + "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "searchLinks": { "description": "Retrieve a list of links connected to a specific asset. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them. You can retrieve links in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchLinks", @@ -1247,7 +1275,7 @@ } } }, - "revision": "20260410", + "revision": "20260506", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { @@ -1342,7 +1370,7 @@ "type": "array" }, "pageSize": { - "description": "The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value.", + "description": "Optional. The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value.", "format": "int32", "type": "integer" }, @@ -1371,10 +1399,38 @@ }, "type": "object" }, + "GoogleCloudDatacatalogLineageV1DependencyInfo": { + "description": "Dependency info describes how one entity depends on another.", + "id": "GoogleCloudDatacatalogLineageV1DependencyInfo", + "properties": { + "dependencyType": { + "description": "Required. Type of dependency.", + "enum": [ + "DEPENDENCY_TYPE_UNSPECIFIED", + "EXACT_COPY", + "OTHER" + ], + "enumDescriptions": [ + "Dependency type unspecified.", + "Exact data copy without any change.", + "Other types of dependencies like filtering or grouping." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDatacatalogLineageV1EntityReference": { "description": "The soft reference to everything you can attach a lineage event to.", "id": "GoogleCloudDatacatalogLineageV1EntityReference", "properties": { + "field": { + "description": "Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage For example to address \"salary.net\" subfield where \"salary\" is a column and \"net\" is a proto field two values in the `field` should be reported, the first is \"salary\" and the second is \"net\". Each field length is limited to 500 characters. Maximum supported nesting level is 20.", + "items": { + "type": "string" + }, + "type": "array" + }, "fullyQualifiedName": { "description": "Required. [Fully Qualified Name (FQN)](https://cloud.google.com/dataplex/docs/fully-qualified-names) of the entity.", "type": "string" @@ -1386,6 +1442,10 @@ "description": "A lineage between source and target entities.", "id": "GoogleCloudDatacatalogLineageV1EventLink", "properties": { + "dependencyInfo": { + "$ref": "GoogleCloudDatacatalogLineageV1DependencyInfo", + "description": "Optional. Describes how the target depends on the source." + }, "source": { "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", "description": "Required. Reference to the source entity" @@ -1425,10 +1485,87 @@ }, "type": "object" }, + "GoogleCloudDatacatalogLineageV1LineageLink": { + "description": "Lineage link between two entities.", + "id": "GoogleCloudDatacatalogLineageV1LineageLink", + "properties": { + "dependencyInfo": { + "description": "Describes how the target entity is dependent on the source entity.", + "items": { + "$ref": "GoogleCloudDatacatalogLineageV1LineageLinkDependencyInfo" + }, + "type": "array" + }, + "depth": { + "description": "Depth of the current link in the graph starting from 1.", + "format": "int32", + "type": "integer" + }, + "location": { + "description": "The location where the LineageEvent that created the link is stored.", + "type": "string" + }, + "processes": { + "description": "Processes metadata associated with the link.", + "items": { + "$ref": "GoogleCloudDatacatalogLineageV1LineageLinkLineageProcess" + }, + "type": "array" + }, + "source": { + "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", + "description": "The entity that is the **source** of this link." + }, + "target": { + "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", + "description": "The entity that is the **target** of this link." + } + }, + "type": "object" + }, + "GoogleCloudDatacatalogLineageV1LineageLinkDependencyInfo": { + "description": "Dependency info describes how one entity is dependent on another.", + "id": "GoogleCloudDatacatalogLineageV1LineageLinkDependencyInfo", + "properties": { + "dependencyType": { + "description": "The type of dependency.", + "enum": [ + "DEPENDENCY_TYPE_UNSPECIFIED", + "EXACT_COPY", + "OTHER" + ], + "enumDescriptions": [ + "Dependency type unspecified.", + "Exact data copy without any change.", + "Other types of dependencies like filtering or grouping." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatacatalogLineageV1LineageLinkLineageProcess": { + "description": "Process metadata for the link.", + "id": "GoogleCloudDatacatalogLineageV1LineageLinkLineageProcess", + "properties": { + "process": { + "$ref": "GoogleCloudDatacatalogLineageV1Process", + "description": "Process that created the link." + } + }, + "type": "object" + }, "GoogleCloudDatacatalogLineageV1Link": { "description": "Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are created when LineageEvents record data transformation between related assets.", "id": "GoogleCloudDatacatalogLineageV1Link", "properties": { + "dependencyInfo": { + "description": "Optional. The dependency info of the link (applies only to column level links).", + "items": { + "$ref": "GoogleCloudDatacatalogLineageV1LinkDependencyInfo" + }, + "type": "array" + }, "endTime": { "description": "The end of the last event establishing this link.", "format": "google-datetime", @@ -1455,6 +1592,27 @@ }, "type": "object" }, + "GoogleCloudDatacatalogLineageV1LinkDependencyInfo": { + "description": "Dependency info describes how one entity depends on another.", + "id": "GoogleCloudDatacatalogLineageV1LinkDependencyInfo", + "properties": { + "dependencyType": { + "description": "The type of dependency.", + "enum": [ + "DEPENDENCY_TYPE_UNSPECIFIED", + "EXACT_COPY", + "OTHER" + ], + "enumDescriptions": [ + "Dependency type unspecified.", + "Exact data copy without any change.", + "Other types of dependencies like filtering or grouping." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse": { "description": "Response message for ListLineageEvents.", "id": "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse", @@ -1509,6 +1667,20 @@ }, "type": "object" }, + "GoogleCloudDatacatalogLineageV1MultipleEntityReference": { + "description": "Multiple entity reference for SearchLinksRequest.", + "id": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", + "properties": { + "entities": { + "description": "Optional. The list of entities to search for links. The maximum number of entities is 20.", + "items": { + "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDatacatalogLineageV1OperationMetadata": { "description": "Metadata describing the operation.", "id": "GoogleCloudDatacatalogLineageV1OperationMetadata", @@ -1710,7 +1882,7 @@ "type": "object" }, "displayName": { - "description": "Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`", + "description": "Optional. A human-readable name you can set to display in a user interface. Must be not longer than 200 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`", "type": "string" }, "endTime": { @@ -1748,6 +1920,141 @@ }, "type": "object" }, + "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequest": { + "description": "Request message for SearchLineageStreaming.", + "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequest", + "properties": { + "direction": { + "description": "Required. Direction of the search.", + "enum": [ + "SEARCH_DIRECTION_UNSPECIFIED", + "DOWNSTREAM", + "UPSTREAM" + ], + "enumDescriptions": [ + "Direction is unspecified.", + "Retrieve links that lead from the specified asset to downstream assets.", + "Retrieve links that lead from upstream assets to the specified asset." + ], + "type": "string" + }, + "filters": { + "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchFilters", + "description": "Optional. Filters for the search." + }, + "limits": { + "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchLimits", + "description": "Optional. Limits for the search." + }, + "locations": { + "description": "Required. The locations to search in.", + "items": { + "type": "string" + }, + "type": "array" + }, + "rootCriteria": { + "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestRootCriteria", + "description": "Required. Criteria for the root of the search." + } + }, + "type": "object" + }, + "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestRootCriteria": { + "description": "Criteria for the root of the search.", + "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestRootCriteria", + "properties": { + "entities": { + "$ref": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", + "description": "Optional. The entities to initiate the search from. Entities can be specified by FQN only, or by FQN and field. To search by FQN and all available fields for that FQN, use the wildcard `*` as the field value." + } + }, + "type": "object" + }, + "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchFilters": { + "description": "Filters for the search.", + "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchFilters", + "properties": { + "dependencyTypes": { + "description": "Optional. Types of dependencies between entities to retrieve. If unspecified, all dependency types are returned.", + "items": { + "enum": [ + "DEPENDENCY_TYPE_UNSPECIFIED", + "EXACT_COPY", + "OTHER" + ], + "enumDescriptions": [ + "Dependency type unspecified.", + "Exact data copy without any change.", + "Other types of dependencies like filtering or grouping." + ], + "type": "string" + }, + "type": "array" + }, + "entitySet": { + "description": "Optional. Entity set restriction. If unspecified, the method returns all entities.", + "enum": [ + "ENTITY_SET_UNSPECIFIED", + "ENTITIES" + ], + "enumDescriptions": [ + "The entity set is unspecified. Returns all the data.", + "Returns entities with only FQN specified. For example, entities with the `field` field set are not returned." + ], + "type": "string" + }, + "timeRange": { + "$ref": "GoogleTypeInterval", + "description": "Optional. Time interval to search for lineage. If unspecified, all lineage is returned. Currently, at most one of `start_time` and `end_time` can be set." + } + }, + "type": "object" + }, + "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchLimits": { + "description": "Limits for the search results.", + "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchLimits", + "properties": { + "maxDepth": { + "description": "Optional. The maximum depth of the search. The default value is 5 and maximum value is 100.", + "format": "int32", + "type": "integer" + }, + "maxProcessPerLink": { + "description": "Optional. The maximum number of processes to return per link. The default value is 0 and the maximum value is 100. If this value is non-zero, the response will contain process names for the links. To retrieve full process details in the response, include `links.processes.process` in the [FieldMask](https://developers.google.com/workspace/docs/api/how-tos/field-masks#read_with_a_field_mask).", + "format": "int32", + "type": "integer" + }, + "maxResults": { + "description": "Optional. The maximum number of links to return in the response. The default value is 1_000 and the maximum value is 10_000.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse": { + "description": "Response message for SearchLineageStreaming.", + "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse", + "properties": { + "links": { + "description": "Output only. The lineage links that match the search criteria. Can be empty if no links match.", + "items": { + "$ref": "GoogleCloudDatacatalogLineageV1LineageLink" + }, + "readOnly": true, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. If non-empty, the result set might be incomplete. Currently, only locations are supported. Format: `projects/[PROJECT_NUMBER]/locations/[LOCATION]` Example: projects/123456789/locations/us-east1", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDatacatalogLineageV1SearchLinksRequest": { "description": "Request message for SearchLinks.", "id": "GoogleCloudDatacatalogLineageV1SearchLinksRequest", @@ -1765,9 +2072,17 @@ "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", "description": "Optional. Send asset information in the **source** field to retrieve all links that lead from the specified asset to downstream assets." }, + "sources": { + "$ref": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", + "description": "Optional. Send a list of asset information in the **sources** field to retrieve all links that lead from the specified assets to downstream assets. This field is similar to the `source` source field but allows providing multiple entities. All entities within the `MultipleEntityReference` must have the same `fully_qualified_name`." + }, "target": { "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", "description": "Optional. Send asset information in the **target** field to retrieve all links that lead from upstream assets to the specified asset." + }, + "targets": { + "$ref": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", + "description": "Optional. Send a list of asset information in the **targets** field to retrieve all links that lead from upstream assets to the specified assets. This field is similar to the `target` target field but allows providing multiple entities. All entities within the `MultipleEntityReference` must have the same `fully_qualified_name`." } }, "type": "object" @@ -1888,6 +2203,23 @@ } }, "type": "object" + }, + "GoogleTypeInterval": { + "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", + "id": "GoogleTypeInterval", + "properties": { + "endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/datamanager-v1.json b/discovery/datamanager-v1.json index 5ef7d515844..1a9abfa6ae4 100644 --- a/discovery/datamanager-v1.json +++ b/discovery/datamanager-v1.json @@ -820,7 +820,7 @@ } } }, - "revision": "20260420", + "revision": "20260507", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdIdentifiers": { @@ -839,6 +839,10 @@ "$ref": "DeviceInfo", "description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad." }, + "mobileDeviceId": { + "description": "Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.", + "type": "string" + }, "sessionAttributes": { "description": "Optional. Session attributes for event attribution and modeling.", "type": "string" @@ -961,6 +965,13 @@ "description": "The cart data associated with the event.", "id": "CartData", "properties": { + "couponCodes": { + "description": "Optional. The list of coupon codes that were applied to the cart. Cart-level and item-level coupon codes are independent. If the event is for a Google Analytics destination, only provide a single coupon code. Google Analytics ignores additional coupon codes.", + "items": { + "type": "string" + }, + "type": "array" + }, "items": { "description": "Optional. The list of items associated with the event.", "items": { @@ -1107,10 +1118,52 @@ "description": "Information about the device being used (if any) when the event happened.", "id": "DeviceInfo", "properties": { + "brand": { + "description": "Optional. The brand of the device.", + "type": "string" + }, + "browser": { + "description": "Optional. The brand or type of the browser.", + "type": "string" + }, + "browserVersion": { + "description": "Optional. The version of the browser.", + "type": "string" + }, + "category": { + "description": "Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”.", + "type": "string" + }, "ipAddress": { "description": "Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.", "type": "string" }, + "languageCode": { + "description": "Optional. The language the device uses in ISO 639-1 format.", + "type": "string" + }, + "model": { + "description": "Optional. The model of the device.", + "type": "string" + }, + "operatingSystem": { + "description": "Optional. The operating system or platform of the device.", + "type": "string" + }, + "operatingSystemVersion": { + "description": "Optional. The version of the operating system or platform.", + "type": "string" + }, + "screenHeight": { + "description": "Optional. The height of the screen in pixels.", + "format": "int32", + "type": "integer" + }, + "screenWidth": { + "description": "Optional. The width of the screen in pixels.", + "format": "int32", + "type": "integer" + }, "userAgent": { "description": "Optional. The user-agent string of the device for the given context.", "type": "string" @@ -1176,37 +1229,6 @@ "PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER", "PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID" ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - true - ], "enumDescriptions": [ "The processing error reason is unknown.", "The custom variable is invalid.", @@ -1277,6 +1299,10 @@ }, "type": "array" }, + "appInstanceId": { + "description": "Optional. A unique identifier for the user instance of an app client for this GA4 app stream.", + "type": "string" + }, "cartData": { "$ref": "CartData", "description": "Optional. Information about the transaction and items associated with the event." @@ -1316,6 +1342,10 @@ "$ref": "DeviceInfo", "description": "Optional. Information gathered about the device being used (if any) when the event happened." }, + "eventLocation": { + "$ref": "EventLocation", + "description": "Optional. Information gathered about the location of the user when this event occurred." + }, "eventName": { "description": "Optional. The name of the event. Required for GA4 events.", "type": "string" @@ -1328,6 +1358,7 @@ "APP", "IN_STORE", "PHONE", + "MESSAGE", "OTHER" ], "enumDescriptions": [ @@ -1336,6 +1367,7 @@ "The event was generated from an app.", "The event was generated from an in-store transaction.", "The event was generated from a phone call.", + "The event was generated from a message.", "The event was generated from other sources." ], "type": "string" @@ -1357,8 +1389,12 @@ "format": "google-datetime", "type": "string" }, + "thirdPartyUserData": { + "$ref": "UserData", + "description": "Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data." + }, "transactionId": { - "description": "Optional. The unique identifier for this event. Required for conversions using multiple data sources.", + "description": "Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.", "type": "string" }, "userData": { @@ -1376,6 +1412,37 @@ }, "type": "object" }, + "EventLocation": { + "description": "The location where the event occurred.", + "id": "EventLocation", + "properties": { + "city": { + "description": "Optional. The name of the city where the event occurred.", + "type": "string" + }, + "continentCode": { + "description": "Optional. The continent code in UN M49 format where the event occurred.", + "type": "string" + }, + "regionCode": { + "description": "Optional. The 2-letter CLDR region code of the user's address.", + "type": "string" + }, + "storeId": { + "description": "Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.", + "type": "string" + }, + "subcontinentCode": { + "description": "Optional. The subcontinent code in UN M49 format where the event occurred.", + "type": "string" + }, + "subdivisionCode": { + "description": "Optional. The ISO 3166-2 subdivision code where the event occurred.", + "type": "string" + } + }, + "type": "object" + }, "EventParameter": { "description": "Event parameter for GA4 events.", "id": "EventParameter", @@ -1776,10 +1843,34 @@ }, "type": "array" }, + "conversionValue": { + "description": "Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.", + "format": "double", + "type": "number" + }, + "customVariables": { + "description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.", + "items": { + "$ref": "ItemCustomVariable" + }, + "type": "array" + }, "itemId": { "description": "Optional. A unique identifier to reference the item.", "type": "string" }, + "merchantFeedLabel": { + "description": "Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.", + "type": "string" + }, + "merchantFeedLanguageCode": { + "description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.", + "type": "string" + }, + "merchantId": { + "description": "Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.", + "type": "string" + }, "merchantProductId": { "description": "Optional. The product ID within the Merchant Center account.", "type": "string" @@ -1797,6 +1888,28 @@ }, "type": "object" }, + "ItemCustomVariable": { + "description": "Item-level custom variable for ads conversions.", + "id": "ItemCustomVariable", + "properties": { + "destinationReferences": { + "description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.", + "items": { + "type": "string" + }, + "type": "array" + }, + "value": { + "description": "Optional. The value to store for the custom variable.", + "type": "string" + }, + "variable": { + "description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.", + "type": "string" + } + }, + "type": "object" + }, "ItemParameter": { "description": "A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", "id": "ItemParameter", @@ -2420,7 +2533,7 @@ }, "errorInfo": { "$ref": "ErrorInfo", - "description": "An error info error containing the error reason and error counts related to the upload." + "description": "An error info error containing the error reason and error counts related to the upload. Only populated if the `request_status` is `FAILED` or `PARTIAL_SUCCESS`. This field isn't populated while the request has `request_status` of `PROCESSING`." }, "eventsIngestionStatus": { "$ref": "IngestEventsStatus", @@ -2437,16 +2550,16 @@ ], "enumDescriptions": [ "The request status is unknown.", - "The request succeeded.", + "Processing succeeded for all records without any errors. However, there may be warnings in the `warning_info` field.", "The request is processing.", - "The request failed.", - "The request partially succeeded." + "Processing failed for all records. Check the `error_info` field for error details, and check the `warning_info` field for warning details.", + "Processing completed successfully without errors for some records, but failed with errors for other records. Check the `error_info` field for error details, and check the `warning_info` field for warning details." ], "type": "string" }, "warningInfo": { "$ref": "WarningInfo", - "description": "A warning info containing the warning reason and warning counts related to the upload." + "description": "A warning info containing the warning reason and warning counts related to the upload. This field isn't populated while the request has `request_status` of `PROCESSING`." } }, "type": "object" @@ -2522,11 +2635,23 @@ "readOnly": true, "type": "string" }, + "gmailMembersCount": { + "description": "Output only. Estimated number of members in this user list on Gmail.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "searchNetworkMembersCount": { "description": "Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.", "format": "int64", "readOnly": true, "type": "string" + }, + "youtubeMembersCount": { + "description": "Output only. Estimated number of members in this user list on YouTube.", + "format": "int64", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3228,7 +3353,7 @@ "The WIP could not be used because it was rejected by its attestation condition.", "The WIP is formatted incorrectly or the WIP does not exist.", "The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.", - "Failed to decrypt th UserIdentifier data using the DEK.", + "Failed to decrypt the UserIdentifier data using the DEK.", "Internal error.", "The system failed to authenticate with AWS." ], diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index cc01f70e68b..54e29ec1db6 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -2341,7 +2341,7 @@ ], "parameters": { "dataScanId": { - "description": "Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.", + "description": "Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix \"data-scan-\". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.", "location": "query", "type": "string" }, @@ -7490,7 +7490,7 @@ } } }, - "revision": "20260428", + "revision": "20260504", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -13219,6 +13219,10 @@ "description": "Lookup Context using permissions in the source system.", "id": "GoogleCloudDataplexV1LookupContextRequest", "properties": { + "context": { + "description": "Optional. The text representing contextual information for which metadata context is being requested.", + "type": "string" + }, "options": { "additionalProperties": { "type": "string" diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index 97e7db927c9..bed65a08454 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -3869,7 +3869,7 @@ ], "parameters": { "filter": { - "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", + "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be \"*\" to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", "location": "query", "type": "string" }, @@ -5224,7 +5224,7 @@ } } }, - "revision": "20260427", + "revision": "20260501", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -6176,9 +6176,9 @@ "CLUSTER_TIER_PREMIUM" ], "enumDescriptions": [ - "Not set. Works the same as CLUSTER_TIER_STANDARD.", - "Standard Dataproc cluster.", - "Premium Dataproc cluster." + "Uses standard tier if unspecified.", + "Standard cluster tier.", + "Premium cluster tier." ], "type": "string" }, @@ -6199,7 +6199,7 @@ "type": "string" }, "configBucket": { - "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Dataproc determines a Cloud Storage location (US, ASIA, or EU) for the cluster staging bucket according to the Compute Engine zone where the cluster is deployed, and then creates and manages this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", "type": "string" }, "dataprocMetricConfig": { @@ -6273,7 +6273,7 @@ "description": "Optional. The config settings for cluster software." }, "tempBucket": { - "description": "Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "description": "Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc determines a Cloud Storage location (US, ASIA, or EU) for the cluster temp bucket according to the Compute Engine zone where the cluster is deployed, and then creates and manages this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", "type": "string" }, "workerConfig": { @@ -6567,7 +6567,8 @@ "id": "ConfidentialInstanceConfig", "properties": { "enableConfidentialCompute": { - "description": "Optional. Defines whether the instance should have confidential compute enabled.", + "deprecated": true, + "description": "Optional. Deprecated: Use 'confidential_instance_type' instead. Defines whether the instance should have confidential compute enabled.", "type": "boolean" } }, @@ -6753,11 +6754,11 @@ "type": "integer" }, "bootDiskType": { - "description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).", + "description": "Optional. Type of the boot disk (default is pd-standard). Valid values: pd-balanced (Persistent Disk Balanced Solid State Drive), pd-ssd (Persistent Disk Solid State Drive), or pd-standard (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).", "type": "string" }, "localSsdInterface": { - "description": "Optional. Interface type of local SSDs (default is \"scsi\"). Valid values: \"scsi\" (Small Computer System Interface), \"nvme\" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).", + "description": "Optional. Interface type of local SSDs (default is scsi). Valid values: scsi (Small Computer System Interface), nvme (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).", "type": "string" }, "numLocalSsds": { @@ -7375,7 +7376,7 @@ "type": "object" }, "networkUri": { - "description": "Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default", + "description": "Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default", "type": "string" }, "nodeGroupAffinity": { @@ -13237,7 +13238,7 @@ "description": "Required. The configuration for running the Dataproc cluster on Kubernetes." }, "stagingBucket": { - "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Dataproc determines a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", "type": "string" } }, diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index 9f702265d9b..7cf9cb6996c 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -10465,7 +10465,7 @@ } } }, - "revision": "20260310", + "revision": "20260326", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -15419,6 +15419,11 @@ "description": "Contains dependent field value information.", "id": "DependentFieldValue", "properties": { + "dynamicFeedId": { + "description": "Optional. The ID of the dynamic feed that value's field will match against.", + "format": "int64", + "type": "string" + }, "elementId": { "description": "Optional. The ID of the element that value's field will match against.", "format": "int64", diff --git a/discovery/dfareporting-v5.json b/discovery/dfareporting-v5.json index f053ab91c38..9e5ad52cecc 100644 --- a/discovery/dfareporting-v5.json +++ b/discovery/dfareporting-v5.json @@ -10091,7 +10091,7 @@ } } }, - "revision": "20260310", + "revision": "20260326", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -14984,6 +14984,11 @@ "description": "Contains dependent field value information.", "id": "DependentFieldValue", "properties": { + "dynamicFeedId": { + "description": "Optional. The ID of the dynamic feed that value's field will match against.", + "format": "int64", + "type": "string" + }, "elementId": { "description": "Optional. The ID of the element that value's field will match against.", "format": "int64", diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 3e63b042cde..7159bbc59e2 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -8780,7 +8780,7 @@ } } }, - "revision": "20260426", + "revision": "20260509", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -13676,6 +13676,12 @@ "" ], "type": "string" + }, + "proactiveEnabled": { + "type": "boolean" + }, + "reactiveEnabled": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index 7d8b1959ab4..4cc8b75565b 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -8431,7 +8431,7 @@ } } }, - "revision": "20260426", + "revision": "20260509", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -16052,6 +16052,12 @@ "" ], "type": "string" + }, + "proactiveEnabled": { + "type": "boolean" + }, + "reactiveEnabled": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/firebaseappdistribution-v1.json b/discovery/firebaseappdistribution-v1.json index edfeb5565b7..968255a50ee 100644 --- a/discovery/firebaseappdistribution-v1.json +++ b/discovery/firebaseappdistribution-v1.json @@ -946,7 +946,7 @@ } } }, - "revision": "20260430", + "revision": "20260511", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1366,6 +1366,11 @@ "format": "byte", "type": "string" }, + "sha512Hash": { + "description": "Scotty-provided SHA512 hash for an upload.", + "format": "byte", + "type": "string" + }, "timestamp": { "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", "format": "uint64", diff --git a/discovery/firebasedataconnect-v1.json b/discovery/firebasedataconnect-v1.json index 81bc35a8791..405320e5d61 100644 --- a/discovery/firebasedataconnect-v1.json +++ b/discovery/firebasedataconnect-v1.json @@ -462,6 +462,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateQuery": { + "description": "Generates a GraphQL query based on a natural language prompt and the provided schema context. This is a stateless method; the schema is provided per request to support local development states. Streams results with real-time status and output chunks.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:generateQuery", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.generateQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the service in which to generate the query. Format: projects/{project}/locations/{location}/services/{service}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateQuery", + "request": { + "$ref": "GenerateQueryRequest" + }, + "response": { + "$ref": "GenerateQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSchema": { + "description": "Generates GraphQL schema based on a natural language prompt or data description. This allows users to scaffold new types and tables quickly. Streams results with real-time status and output chunks.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:generateSchema", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.generateSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the service in which to generate the schema. Format: projects/{project}/locations/{location}/services/{service}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateSchema", + "request": { + "$ref": "GenerateSchemaRequest" + }, + "response": { + "$ref": "GenerateSchemaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a single Service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", @@ -1165,7 +1221,7 @@ } } }, - "revision": "20260426", + "revision": "20260502", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1200,6 +1256,21 @@ }, "type": "object" }, + "CodeChunk": { + "description": "A chunk of code.", + "id": "CodeChunk", + "properties": { + "code": { + "description": "Required. The code content string.", + "type": "string" + }, + "languageCode": { + "description": "Optional. Specifies the language if we expand support beyond GraphQL (e.g., SQL or JSON) The standard is BCP-47 language code.", + "type": "string" + } + }, + "type": "object" + }, "Connector": { "description": "Connector consists of a set of operations, i.e. queries and mutations.", "id": "Connector", @@ -1420,6 +1491,94 @@ }, "type": "object" }, + "GenerateQueryRequest": { + "description": "Request message for GenerateQuery.", + "id": "GenerateQueryRequest", + "properties": { + "prompt": { + "description": "Required. The natural language description of the desired query. Example: \"Find all users who signed up in the last 7 days.\"", + "type": "string" + }, + "schemas": { + "description": "Optional. The user's locally defined FDC Schema(s). If not defined, the backend will fetch the user's deployed schema.", + "items": { + "$ref": "Schema" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenerateQueryResponse": { + "description": "Output for streaming generate query requests", + "id": "GenerateQueryResponse", + "properties": { + "part": { + "$ref": "Part", + "description": "Required. The content from the current conversational turn." + }, + "status": { + "$ref": "GenerationStatus", + "description": "Essential for providing responsive UI feedback (e.g., a spinner or \"Analyzing schema...\" step)." + } + }, + "type": "object" + }, + "GenerateSchemaRequest": { + "description": "Request message for GenerateSchema.", + "id": "GenerateSchemaRequest", + "properties": { + "prompt": { + "description": "Required. The natural language description of the data model to generate. Example: \"A blog system with Users, Posts, and Comments. Users can have multiple posts.\"", + "type": "string" + } + }, + "type": "object" + }, + "GenerateSchemaResponse": { + "description": "Output for streaming generate schema requests", + "id": "GenerateSchemaResponse", + "properties": { + "part": { + "$ref": "Part", + "description": "The content from the current conversational turn." + }, + "status": { + "$ref": "GenerationStatus", + "description": "Essential for providing responsive UI feedback (e.g., a spinner or \"Analyzing schema...\" step)." + } + }, + "type": "object" + }, + "GenerationStatus": { + "description": "Represents the progress of the server side generation request.", + "id": "GenerationStatus", + "properties": { + "message": { + "description": "Output only. A message providing more details about the state.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of generation.", + "enum": [ + "STATE_UNSPECIFIED", + "ANALYZING_CODE", + "GENERATING_CODE", + "COMPLETED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The agent is analyzing schema or operations.", + "The agent is generating code", + "Generation is complete." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GraphqlError": { "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase SQL Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.", "id": "GraphqlError", @@ -1902,6 +2061,21 @@ }, "type": "object" }, + "Part": { + "description": "Represents a chunk of content.", + "id": "Part", + "properties": { + "codeChunk": { + "$ref": "CodeChunk", + "description": "Optional. A chunk of code." + }, + "textChunk": { + "$ref": "TextChunk", + "description": "Optional. A chunk of text." + } + }, + "type": "object" + }, "PostgreSql": { "description": "Settings for PostgreSQL data source.", "id": "PostgreSql", @@ -1924,19 +2098,19 @@ "type": "string" }, "schemaMigration": { - "description": "Optional. Configure how to perform Postgresql schema migration.", + "description": "Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation.", "enum": [ "SQL_SCHEMA_MIGRATION_UNSPECIFIED", "MIGRATE_COMPATIBLE" ], "enumDescriptions": [ "Unspecified SQL schema migration.", - "Connect to the SQL database and identify any missing SQL resources used in the given Firebase SQL Connect Schema. Automatically create necessary SQL resources (SQL table, column, etc) before deploying the schema. During migration steps, the SQL Schema must comply with the previous before_deploy setting in case the migration is interrupted. Therefore, the previous before_deploy setting must not be `schema_validation=STRICT`." + "Waits for the Cloud SQL instance to be provisioned and automatically creates necessary SQL resources (tables, columns, etc.) to match the desired FDC schema. This operation is strictly additive and executes as a Long-Running Operation during provisioning. Rejects migrations on a non-empty existing SQL schema." ], "type": "string" }, "schemaValidation": { - "description": "Optional. Configure how much Postgresql schema validation to perform.", + "description": "Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema.", "enum": [ "SQL_SCHEMA_VALIDATION_UNSPECIFIED", "NONE", @@ -1944,10 +2118,10 @@ "COMPATIBLE" ], "enumDescriptions": [ - "Unspecified SQL schema validation. Default to STRICT.", - "Skip no SQL schema validation. Use it with extreme caution. CreateSchema or UpdateSchema will succeed even if SQL database is unavailable or SQL schema is incompatible. Generated SQL may fail at execution time.", - "Connect to the SQL database and validate that the SQL DDL matches the schema exactly. Surface any discrepancies as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail.", - "Connect to the SQL database and validate that the SQL DDL has all the SQL resources used in the given Firebase SQL Connect Schema. Surface any missing resources as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail. Succeed even if there are unknown tables and columns." + "Unspecified SQL schema validation. Defaults to STRICT.", + "Skips SQL schema validation. Deployment succeeds even if the database is pending provisioning, unavailable, or incompatible. Under NONE, newly created services route requests to a temporary ephemeral database (in-memory emulation) so the API can be tested immediately. Ephemeral data expires after 24 hours unless successfully validated or migrated to a linked database.", + "Connects to the SQL database and validates that the SQL DDL matches the FDC schema exactly. Any discrepancies (extra or missing tables/columns) result in a FAILED_PRECONDITION error with required SQL diffs. Recommended for greenfield projects to ensure full schema consistency.", + "Connects to the SQL database and validates that it contains all the SQL resources required by the FDC schema. Succeeds even if the database contains additional tables or columns not used by FDC. Suitable when sharing a database with other tools or legacy applications." ], "type": "string" }, @@ -2140,6 +2314,17 @@ }, "type": "object" }, + "TextChunk": { + "description": "A chunk of conversational text.", + "id": "TextChunk", + "properties": { + "text": { + "description": "Required. The text content string.", + "type": "string" + } + }, + "type": "object" + }, "Workaround": { "description": "Workaround provides suggestions to address errors and warnings.", "id": "Workaround", diff --git a/discovery/firebasedataconnect-v1beta.json b/discovery/firebasedataconnect-v1beta.json index 733e2e9ddd5..3b9d0f5a459 100644 --- a/discovery/firebasedataconnect-v1beta.json +++ b/discovery/firebasedataconnect-v1beta.json @@ -462,6 +462,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateQuery": { + "description": "Generates a GraphQL query based on a natural language prompt and the provided schema context. This is a stateless method; the schema is provided per request to support local development states. Streams results with real-time status and output chunks.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:generateQuery", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.generateQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the service in which to generate the query. Format: projects/{project}/locations/{location}/services/{service}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:generateQuery", + "request": { + "$ref": "GenerateQueryRequest" + }, + "response": { + "$ref": "GenerateQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSchema": { + "description": "Generates GraphQL schema based on a natural language prompt or data description. This allows users to scaffold new types and tables quickly. Streams results with real-time status and output chunks.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:generateSchema", + "httpMethod": "POST", + "id": "firebasedataconnect.projects.locations.services.generateSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the service in which to generate the schema. Format: projects/{project}/locations/{location}/services/{service}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:generateSchema", + "request": { + "$ref": "GenerateSchemaRequest" + }, + "response": { + "$ref": "GenerateSchemaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a single Service.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", @@ -1165,7 +1221,7 @@ } } }, - "revision": "20260426", + "revision": "20260502", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1200,6 +1256,21 @@ }, "type": "object" }, + "CodeChunk": { + "description": "A chunk of code.", + "id": "CodeChunk", + "properties": { + "code": { + "description": "Required. The code content string.", + "type": "string" + }, + "languageCode": { + "description": "Optional. Specifies the language if we expand support beyond GraphQL (e.g., SQL or JSON) The standard is BCP-47 language code.", + "type": "string" + } + }, + "type": "object" + }, "Connector": { "description": "Connector consists of a set of operations, i.e. queries and mutations.", "id": "Connector", @@ -1420,6 +1491,94 @@ }, "type": "object" }, + "GenerateQueryRequest": { + "description": "Request message for GenerateQuery.", + "id": "GenerateQueryRequest", + "properties": { + "prompt": { + "description": "Required. The natural language description of the desired query. Example: \"Find all users who signed up in the last 7 days.\"", + "type": "string" + }, + "schemas": { + "description": "Optional. The user's locally defined FDC Schema(s). If not defined, the backend will fetch the user's deployed schema.", + "items": { + "$ref": "Schema" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenerateQueryResponse": { + "description": "Output for streaming generate query requests", + "id": "GenerateQueryResponse", + "properties": { + "part": { + "$ref": "Part", + "description": "Required. The content from the current conversational turn." + }, + "status": { + "$ref": "GenerationStatus", + "description": "Essential for providing responsive UI feedback (e.g., a spinner or \"Analyzing schema...\" step)." + } + }, + "type": "object" + }, + "GenerateSchemaRequest": { + "description": "Request message for GenerateSchema.", + "id": "GenerateSchemaRequest", + "properties": { + "prompt": { + "description": "Required. The natural language description of the data model to generate. Example: \"A blog system with Users, Posts, and Comments. Users can have multiple posts.\"", + "type": "string" + } + }, + "type": "object" + }, + "GenerateSchemaResponse": { + "description": "Output for streaming generate schema requests", + "id": "GenerateSchemaResponse", + "properties": { + "part": { + "$ref": "Part", + "description": "The content from the current conversational turn." + }, + "status": { + "$ref": "GenerationStatus", + "description": "Essential for providing responsive UI feedback (e.g., a spinner or \"Analyzing schema...\" step)." + } + }, + "type": "object" + }, + "GenerationStatus": { + "description": "Represents the progress of the server side generation request.", + "id": "GenerationStatus", + "properties": { + "message": { + "description": "Output only. A message providing more details about the state.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of generation.", + "enum": [ + "STATE_UNSPECIFIED", + "ANALYZING_CODE", + "GENERATING_CODE", + "COMPLETED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The agent is analyzing schema or operations.", + "The agent is generating code", + "Generation is complete." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GraphqlError": { "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase SQL Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.", "id": "GraphqlError", @@ -1902,6 +2061,21 @@ }, "type": "object" }, + "Part": { + "description": "Represents a chunk of content.", + "id": "Part", + "properties": { + "codeChunk": { + "$ref": "CodeChunk", + "description": "Optional. A chunk of code." + }, + "textChunk": { + "$ref": "TextChunk", + "description": "Optional. A chunk of text." + } + }, + "type": "object" + }, "PostgreSql": { "description": "Settings for PostgreSQL data source.", "id": "PostgreSql", @@ -1924,19 +2098,19 @@ "type": "string" }, "schemaMigration": { - "description": "Optional. Configure how to perform Postgresql schema migration.", + "description": "Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation.", "enum": [ "SQL_SCHEMA_MIGRATION_UNSPECIFIED", "MIGRATE_COMPATIBLE" ], "enumDescriptions": [ "Unspecified SQL schema migration.", - "Connect to the SQL database and identify any missing SQL resources used in the given Firebase SQL Connect Schema. Automatically create necessary SQL resources (SQL table, column, etc) before deploying the schema. During migration steps, the SQL Schema must comply with the previous before_deploy setting in case the migration is interrupted. Therefore, the previous before_deploy setting must not be `schema_validation=STRICT`." + "Waits for the Cloud SQL instance to be provisioned and automatically creates necessary SQL resources (tables, columns, etc.) to match the desired FDC schema. This operation is strictly additive and executes as a Long-Running Operation during provisioning. Rejects migrations on a non-empty existing SQL schema." ], "type": "string" }, "schemaValidation": { - "description": "Optional. Configure how much Postgresql schema validation to perform.", + "description": "Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema.", "enum": [ "SQL_SCHEMA_VALIDATION_UNSPECIFIED", "NONE", @@ -1944,10 +2118,10 @@ "COMPATIBLE" ], "enumDescriptions": [ - "Unspecified SQL schema validation. Default to STRICT.", - "Skip no SQL schema validation. Use it with extreme caution. CreateSchema or UpdateSchema will succeed even if SQL database is unavailable or SQL schema is incompatible. Generated SQL may fail at execution time.", - "Connect to the SQL database and validate that the SQL DDL matches the schema exactly. Surface any discrepancies as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail.", - "Connect to the SQL database and validate that the SQL DDL has all the SQL resources used in the given Firebase SQL Connect Schema. Surface any missing resources as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail. Succeed even if there are unknown tables and columns." + "Unspecified SQL schema validation. Defaults to STRICT.", + "Skips SQL schema validation. Deployment succeeds even if the database is pending provisioning, unavailable, or incompatible. Under NONE, newly created services route requests to a temporary ephemeral database (in-memory emulation) so the API can be tested immediately. Ephemeral data expires after 24 hours unless successfully validated or migrated to a linked database.", + "Connects to the SQL database and validates that the SQL DDL matches the FDC schema exactly. Any discrepancies (extra or missing tables/columns) result in a FAILED_PRECONDITION error with required SQL diffs. Recommended for greenfield projects to ensure full schema consistency.", + "Connects to the SQL database and validates that it contains all the SQL resources required by the FDC schema. Succeeds even if the database contains additional tables or columns not used by FDC. Suitable when sharing a database with other tools or legacy applications." ], "type": "string" }, @@ -2140,6 +2314,17 @@ }, "type": "object" }, + "TextChunk": { + "description": "A chunk of conversational text.", + "id": "TextChunk", + "properties": { + "text": { + "description": "Required. The text content string.", + "type": "string" + } + }, + "type": "object" + }, "Workaround": { "description": "Workaround provides suggestions to address errors and warnings.", "id": "Workaround", diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index b0e856a8b76..a1f15936a6e 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20260408", + "revision": "20260510", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -925,6 +925,20 @@ "description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", "id": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "properties": { + "behavior": { + "description": "Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.", + "enum": [ + "UNSPECIFIED", + "BLOCKING", + "NON_BLOCKING" + ], + "enumDescriptions": [ + "This value is unspecified.", + "If set, the system will wait to receive the function response before continuing the conversation.", + "If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model." + ], + "type": "string" + }, "description": { "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", "type": "string" diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 4b70db7f720..897775827df 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2568,7 +2568,7 @@ } } }, - "revision": "20260426", + "revision": "20260429", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7223,7 +7223,7 @@ "type": "object" }, "RolloutSequence": { - "description": "RolloutSequence defines the desired order of upgrades.", + "description": "RolloutSequence defines the desired order of upgrades. Next ID: 20", "id": "RolloutSequence", "properties": { "autoUpgradeConfig": { diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index eb36c22e727..d5f67b0bab7 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2424,7 +2424,7 @@ } } }, - "revision": "20260426", + "revision": "20260429", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6832,7 +6832,7 @@ "type": "object" }, "RolloutSequence": { - "description": "RolloutSequence defines the desired order of upgrades.", + "description": "RolloutSequence defines the desired order of upgrades. Next ID: 20", "id": "RolloutSequence", "properties": { "autoUpgradeConfig": { diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 0836c5ba81b..7dd2a5a62b9 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -139,7 +139,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "healthcare.projects.locations.list", @@ -5171,7 +5171,7 @@ } } }, - "revision": "20260331", + "revision": "20260421", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index ddebd7ffffa..5f43f479089 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -139,7 +139,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "healthcare.projects.locations.list", @@ -5718,7 +5718,7 @@ } } }, - "revision": "20260331", + "revision": "20260421", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/discovery/hypercomputecluster-v1.json b/discovery/hypercomputecluster-v1.json index 712c9824da8..b5909639e67 100644 --- a/discovery/hypercomputecluster-v1.json +++ b/discovery/hypercomputecluster-v1.json @@ -498,7 +498,7 @@ } } }, - "revision": "20260422", + "revision": "20260429", "rootUrl": "https://hypercomputecluster.googleapis.com/", "schemas": { "BootDisk": { @@ -506,7 +506,7 @@ "id": "BootDisk", "properties": { "sizeGb": { - "description": "Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB.", + "description": "Required. Immutable. Size of the disk in gigabytes. Must be at least 40GB.", "format": "int64", "type": "string" }, @@ -958,10 +958,14 @@ "terminalStorageClass": { "description": "Optional. Terminal storage class of the autoclass bucket", "enum": [ - "TERMINAL_STORAGE_CLASS_UNSPECIFIED" + "TERMINAL_STORAGE_CLASS_UNSPECIFIED", + "NEARLINE", + "ARCHIVE" ], "enumDescriptions": [ - "Unspecified terminal storage class" + "Unspecified terminal storage class", + "Nearline terminal storage class", + "Archive terminal storage class" ], "type": "string" } diff --git a/discovery/index.json b/discovery/index.json index 61eb315fbc6..a40b8612f57 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -1740,6 +1740,21 @@ "title": "Cloud Location Finder API", "version": "v1" }, + { + "description": "", + "discoveryRestUrl": "https://cloudnumberregistry.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://docs.cloud.google.com/number-registry/reference/rest", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "cloudnumberregistry:v1alpha", + "kind": "discovery#directoryItem", + "name": "cloudnumberregistry", + "preferred": true, + "title": "Cloud Number Registry API", + "version": "v1alpha" + }, { "description": "Manages continuous profiling information.", "discoveryRestUrl": "https://cloudprofiler.googleapis.com/$discovery/rest?version=v2", diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index fd696977cd7..e7ff7bc1fbc 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -650,7 +650,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2487,7 +2487,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -4079,7 +4079,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5327,7 +5327,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -7140,7 +7140,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -9167,7 +9167,7 @@ } } }, - "revision": "20260421", + "revision": "20260501", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -9648,7 +9648,7 @@ "type": "object" }, "FieldSource": { - "description": "A source that can be used to represent a field within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses.", + "description": "A source that can be used to represent a \"field of data\" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term \"field of data\" is used here because it is not limited to literal fields in the underlying data schema.", "id": "FieldSource", "properties": { "aliasRef": { @@ -11387,7 +11387,7 @@ "type": "object" }, "ProjectedField": { - "description": "Represents a field selected in the query, analogous to an item in a SQL SELECT clause. It specifies the source field and optionally applies transformations like aggregation, casting, regex extraction, or assigns an alias. Use ProjectedField when you need more than just the raw source field name (for which you might use FieldSource directly in QueryBuilderConfig's field_sources list if no transformations or specific operation type are needed).", + "description": "Represents a field selected in the query, analogous to an item in a SQL SELECT clause. It specifies the source field and optionally applies transformations like aggregation, casting, regex extraction, or assigns an alias. Use ProjectedField when you need more than just the raw source field name (for which you might use FieldSource directly in QueryBuilderConfig's field_sources list if no transformations or specific operation type are needed).A ProjectedField can represent either a field present in the data schema (specified via the field property) or a virtual field that is computed from other fields (specified via the virtual_field property).", "id": "ProjectedField", "properties": { "alias": { @@ -11399,7 +11399,7 @@ "type": "string" }, "field": { - "description": "The field name. This will be the field that is selected using the dot notation to display the drill down value.", + "description": "Optional. The field name. This will be the field that is selected using the dot notation to display the drill down value.", "type": "string" }, "operation": { diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index 0c713f8a0bd..847d1ad1513 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -135,7 +135,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "looker.projects.locations.list", @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -715,7 +715,7 @@ } } }, - "revision": "20260326", + "revision": "20260502", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { diff --git a/discovery/managedidentities-v1.json b/discovery/managedidentities-v1.json index e5f8607d13b..3afb7a4f00e 100644 --- a/discovery/managedidentities-v1.json +++ b/discovery/managedidentities-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1526,7 +1526,7 @@ } } }, - "revision": "20260414", + "revision": "20260424", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { diff --git a/discovery/managedidentities-v1alpha1.json b/discovery/managedidentities-v1alpha1.json index 916286f42c3..1ce48a0be34 100644 --- a/discovery/managedidentities-v1alpha1.json +++ b/discovery/managedidentities-v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1526,7 +1526,7 @@ } } }, - "revision": "20260414", + "revision": "20260424", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { diff --git a/discovery/managedidentities-v1beta1.json b/discovery/managedidentities-v1beta1.json index 621aea4fac4..a054fdca67a 100644 --- a/discovery/managedidentities-v1beta1.json +++ b/discovery/managedidentities-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1526,7 +1526,7 @@ } } }, - "revision": "20260414", + "revision": "20260424", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { diff --git a/discovery/merchantapi-products_v1.json b/discovery/merchantapi-products_v1.json index 17adcfe76cf..fb229f643bf 100644 --- a/discovery/merchantapi-products_v1.json +++ b/discovery/merchantapi-products_v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20260501", + "revision": "20260510", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -1111,6 +1111,21 @@ }, "type": "object" }, + "PickupCost": { + "description": "The pickup cost of the item.", + "id": "PickupCost", + "properties": { + "flatRate": { + "$ref": "Price", + "description": "Required. The flat rate pickup cost of the item." + }, + "freeThreshold": { + "$ref": "Price", + "description": "Optional. The price threshold above which pickup is free of charge." + } + }, + "type": "object" + }, "Price": { "description": "The price represented as a number and currency.", "id": "Price", @@ -1872,6 +1887,10 @@ ], "type": "string" }, + "pickupCost": { + "$ref": "PickupCost", + "description": "Optional. The [pickup cost](https://support.google.com/merchants/answer/16988704) for an item when a customer buys it online and picks it up at a store." + }, "pickupMethod": { "description": "The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.", "enum": [ diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index 4a915460a4a..eaff1c30200 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -344,7 +344,7 @@ } } }, - "revision": "20260427", + "revision": "20260504", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -358,6 +358,10 @@ }, "type": "array" }, + "maxSeverity": { + "description": "Maximum severity found among findings.", + "type": "string" + }, "skillName": { "description": "Name of the skill that produced this analysis.", "type": "string" @@ -1294,28 +1298,32 @@ "description": "Category of the finding.", "type": "string" }, - "description": { - "description": "Detailed description of the finding.", - "type": "string" - }, - "filePath": { - "description": "Path to the file where the finding was detected.", - "type": "string" + "location": { + "$ref": "FindingLocation", + "description": "Location (path and line) where the finding was detected." }, - "ruleId": { - "description": "Unique identifier of the rule that produced this finding.", + "scanner": { + "description": "Scanner determines which engine (e.g. static, llm) emitted the finding.", "type": "string" }, "severity": { "description": "Severity of the finding.", "type": "string" - }, - "snippet": { - "description": "Code snippet relevant to the finding.", + } + }, + "type": "object" + }, + "FindingLocation": { + "description": "Location details with file path and line number.", + "id": "FindingLocation", + "properties": { + "filePath": { + "description": "Relative path of the file containing the finding.", "type": "string" }, - "title": { - "description": "Title of the finding.", + "lineNumber": { + "description": "Line number (1-based), or 0 if whole File / unknown.", + "format": "int64", "type": "string" } }, diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index 2cd7c6692e4..26e2b9a673b 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -344,7 +344,7 @@ } } }, - "revision": "20260427", + "revision": "20260504", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -358,6 +358,10 @@ }, "type": "array" }, + "maxSeverity": { + "description": "Maximum severity found among findings.", + "type": "string" + }, "skillName": { "description": "Name of the skill that produced this analysis.", "type": "string" @@ -1289,28 +1293,32 @@ "description": "Category of the finding.", "type": "string" }, - "description": { - "description": "Detailed description of the finding.", - "type": "string" - }, - "filePath": { - "description": "Path to the file where the finding was detected.", - "type": "string" + "location": { + "$ref": "FindingLocation", + "description": "Location (path and line) where the finding was detected." }, - "ruleId": { - "description": "Unique identifier of the rule that produced this finding.", + "scanner": { + "description": "Scanner determines which engine (e.g. static, llm) emitted the finding.", "type": "string" }, "severity": { "description": "Severity of the finding.", "type": "string" - }, - "snippet": { - "description": "Code snippet relevant to the finding.", + } + }, + "type": "object" + }, + "FindingLocation": { + "description": "Location details with file path and line number.", + "id": "FindingLocation", + "properties": { + "filePath": { + "description": "Relative path of the file containing the finding.", "type": "string" }, - "title": { - "description": "Title of the finding.", + "lineNumber": { + "description": "Line number (1-based), or 0 if whole File / unknown.", + "format": "int64", "type": "string" } }, diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index 2031ac470fd..566c8feba68 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -135,7 +135,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "privateca.projects.locations.list", @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1616,7 +1616,7 @@ } } }, - "revision": "20260318", + "revision": "20260430", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -1922,6 +1922,11 @@ "description": "Immutable. A pem-encoded X.509 certificate signing request (CSR).", "type": "string" }, + "requestedNotBeforeTime": { + "description": "Optional. The requested not_before_time of this Certificate. This field may only be set if the CaPool.IssuancePolicy.allow_requester_specified_not_before_time field is set to true for the issuing CaPool. If this field is specified, the certificate will be issued with this 'not_before_time'. If this is not specified, the 'not_before_time' will be set to the issuance time or issuance time minus backdate_duration depending on the CaPool configuration.", + "format": "google-datetime", + "type": "string" + }, "revocationDetails": { "$ref": "RevocationDetails", "description": "Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.", @@ -2553,6 +2558,10 @@ "description": "Defines controls over all certificate issuance within a CaPool.", "id": "IssuancePolicy", "properties": { + "allowRequesterSpecifiedNotBeforeTime": { + "description": "Optional. If set to true, allows requesters to specify the requested_not_before_time field when creating a Certificate. Certificates requested with this option enabled will have a 'not_before_time' equal to the value specified in the request. The 'not_after_time' will be adjusted to preserve the requested lifetime. The maximum time that a certificate can be backdated with these options is 48 hours in the past. This option cannot be set if backdate_duration is set.", + "type": "boolean" + }, "allowedIssuanceModes": { "$ref": "IssuanceModes", "description": "Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates." diff --git a/discovery/privateca-v1beta1.json b/discovery/privateca-v1beta1.json index 83c6059102d..26e9169b116 100644 --- a/discovery/privateca-v1beta1.json +++ b/discovery/privateca-v1beta1.json @@ -135,7 +135,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "privateca.projects.locations.list", @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -591,7 +591,7 @@ } } }, - "revision": "20260318", + "revision": "20260430", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/saasservicemgmt-v1.json b/discovery/saasservicemgmt-v1.json index 6716e5d9d75..e91ab55a26f 100644 --- a/discovery/saasservicemgmt-v1.json +++ b/discovery/saasservicemgmt-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1804,7 +1804,7 @@ } } }, - "revision": "20260415", + "revision": "20260505", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -3096,14 +3096,16 @@ "TYPE_READY", "TYPE_UPDATING", "TYPE_PROVISIONED", - "TYPE_OPERATION_ERROR" + "TYPE_OPERATION_ERROR", + "TYPE_FLAGS_CONFIG_INITIALIZED" ], "enumDescriptions": [ "Condition type is unspecified.", "Condition type is ready.", "Condition type is updating.", "Condition type is provisioned.", - "Condition type is operationError. True when the last unit operation fails with a non-ignorable error." + "Condition type is operationError. True when the last unit operation fails with a non-ignorable error.", + "Condition type is flagsConfigInitialized. True when the flags configuration is synchronized and ready to be served." ], "type": "string" } @@ -3394,7 +3396,8 @@ "TYPE_SUCCEEDED", "TYPE_CANCELLED", "TYPE_APP_CREATED", - "TYPE_APP_COMPONENTS_REGISTERED" + "TYPE_APP_COMPONENTS_REGISTERED", + "TYPE_WORKLOAD_SUCCEEDED" ], "enumDescriptions": [ "Condition type is unspecified.", @@ -3403,7 +3406,8 @@ "Condition type is succeeded.", "Condition type is cancelled.", "Indicates if AppHub app has been created.", - "Indicates if services and workloads have been registered with AppHub." + "Indicates if services and workloads have been registered with AppHub.", + "Indicates if the UnitOperation's core workload execution completed successfully. The workload is the core execution operation performed for a UnitOperation (e.g., provisioning, updating, or deprovisioning resources) excluding post-operation checks." ], "type": "string" } diff --git a/discovery/saasservicemgmt-v1beta1.json b/discovery/saasservicemgmt-v1beta1.json index 78d61aad1ed..bcf3f1d79ea 100644 --- a/discovery/saasservicemgmt-v1beta1.json +++ b/discovery/saasservicemgmt-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2612,7 +2612,7 @@ } } }, - "revision": "20260415", + "revision": "20260505", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -2796,6 +2796,10 @@ "description": "EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.", "id": "EvaluationRule", "properties": { + "allocationId": { + "description": "Optional. The ID of an allocation to target.", + "type": "string" + }, "condition": { "description": "Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.", "type": "string" @@ -2805,7 +2809,12 @@ "type": "string" }, "target": { - "description": "Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.", + "deprecated": true, + "description": "Optional. Deprecated: Use `rule_target` instead. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.", + "type": "string" + }, + "variantId": { + "description": "Optional. The name of a variant to target.", "type": "string" } }, @@ -2829,8 +2838,17 @@ }, "type": "array" }, + "defaultAllocation": { + "description": "Optional. The ID of an allocation to use as the default.", + "type": "string" + }, "defaultTarget": { - "description": "Required. Default variant or allocation of the flag.", + "deprecated": true, + "description": "Optional. Deprecated: Use `base_target` instead. Default variant or allocation of the flag.", + "type": "string" + }, + "defaultVariant": { + "description": "Optional. The name of a variant to use as the default.", "type": "string" }, "rules": { @@ -4658,14 +4676,16 @@ "TYPE_READY", "TYPE_UPDATING", "TYPE_PROVISIONED", - "TYPE_OPERATION_ERROR" + "TYPE_OPERATION_ERROR", + "TYPE_FLAGS_CONFIG_INITIALIZED" ], "enumDescriptions": [ "Condition type is unspecified.", "Condition type is ready.", "Condition type is updating.", "Condition type is provisioned.", - "Condition type is operationError. True when the last unit operation fails with a non-ignorable error." + "Condition type is operationError. True when the last unit operation fails with a non-ignorable error.", + "Condition type is flagsConfigInitialized. True when the flags configuration is synchronized and ready to be served." ], "type": "string" } @@ -4965,7 +4985,8 @@ "TYPE_SUCCEEDED", "TYPE_CANCELLED", "TYPE_APP_CREATED", - "TYPE_APP_COMPONENTS_REGISTERED" + "TYPE_APP_COMPONENTS_REGISTERED", + "TYPE_WORKLOAD_SUCCEEDED" ], "enumDescriptions": [ "Condition type is unspecified.", @@ -4974,7 +4995,8 @@ "Condition type is succeeded.", "Condition type is cancelled.", "Indicates if AppHub app has been created.", - "Indicates if services and workloads have been registered with AppHub." + "Indicates if services and workloads have been registered with AppHub.", + "Indicates if the UnitOperation's core workload execution completed successfully. The workload is the core execution operation performed for a UnitOperation (e.g., provisioning, updating, or deprovisioning resources) excluding post-operation checks." ], "type": "string" } diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index 784b7d64681..b8a35fe4731 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20251229", + "revision": "20260428", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -304,6 +304,10 @@ "description": "Common audit log format for Google Cloud Platform API operations. ", "id": "AuditLog", "properties": { + "apiVersionIdentifier": { + "description": "The API version identifier of the operation that uses interface based versioning (IBV). For example, `\"2026-01-01-preview\"`. The version identifier generally follows the format of [variant_]date[_decorator]. It should not be parsed because the exact format varies across services.", + "type": "string" + }, "authenticationInfo": { "$ref": "AuthenticationInfo", "description": "Authentication information." diff --git a/discovery/solar-v1.json b/discovery/solar-v1.json index 7b86ee0289e..f2c4701beb7 100644 --- a/discovery/solar-v1.json +++ b/discovery/solar-v1.json @@ -114,6 +114,20 @@ "id": "solar.buildingInsights.findClosest", "parameterOrder": [], "parameters": { + "additionalInsights": { + "description": "Optional. A list of additional_insights to be included in the response.", + "enum": [ + "ADDITIONAL_INSIGHTS_UNSPECIFIED", + "DETECTED_ARRAYS" + ], + "enumDescriptions": [ + "The default value. The default BuildingInsights will be returned.", + "Determines whether the response will include the detected arrays. If specified, the `detected_arrays` field will be populated in the response." + ], + "location": "query", + "repeated": true, + "type": "string" + }, "exactQualityRequired": { "description": "Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`.", "location": "query", @@ -304,7 +318,7 @@ } } }, - "revision": "20260208", + "revision": "20260506", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { @@ -323,6 +337,10 @@ "$ref": "LatLng", "description": "A point near the center of the building." }, + "detectedArrays": { + "$ref": "BuildingInsightsDetectedArrays", + "description": "Solar arrays detected on the building. This field is only populated if DETECTED_ARRAYS is included in the request's FindClosestBuildingInsightsRequest.additional_insights." + }, "imageryDate": { "$ref": "Date", "description": "Date that the underlying imagery was acquired. This is approximate." @@ -372,6 +390,33 @@ }, "type": "object" }, + "BuildingInsightsDetectedArrays": { + "description": "Information about solar arrays detected on the building.", + "id": "BuildingInsightsDetectedArrays", + "properties": { + "detectionStatus": { + "description": "Indicates the detection status of solar arrays for this building.", + "enum": [ + "DETECTION_STATUS_UNSPECIFIED", + "DETECTION_STATUS_DATA_UNAVAILABLE", + "DETECTION_STATUS_ARRAYS_DETECTED", + "DETECTION_STATUS_NO_ARRAYS_DETECTED" + ], + "enumDescriptions": [ + "Unspecified status.", + "Detected solar array data is unavailable for this building.", + "At least one solar array has been detected for this building.", + "No solar arrays detected for this building." + ], + "type": "string" + }, + "latestCaptureDate": { + "$ref": "Date", + "description": "The date indicating when the latest solar array data was captured." + } + }, + "type": "object" + }, "CashPurchaseSavings": { "description": "Cost and benefit of an outright purchase of a particular configuration of solar panels with a particular electricity usage.", "id": "CashPurchaseSavings", diff --git a/discovery/vpcaccess-v1.json b/discovery/vpcaccess-v1.json index 844ad97e89c..80f2ba93901 100644 --- a/discovery/vpcaccess-v1.json +++ b/discovery/vpcaccess-v1.json @@ -110,7 +110,7 @@ "locations": { "methods": { "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "vpcaccess.projects.locations.list", @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -395,7 +395,7 @@ } } }, - "revision": "20260322", + "revision": "20260503", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/discovery/vpcaccess-v1beta1.json b/discovery/vpcaccess-v1beta1.json index ffc975e6a4e..7fe2e686d66 100644 --- a/discovery/vpcaccess-v1beta1.json +++ b/discovery/vpcaccess-v1beta1.json @@ -110,7 +110,7 @@ "locations": { "methods": { "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "vpcaccess.projects.locations.list", @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -395,7 +395,7 @@ } } }, - "revision": "20260322", + "revision": "20260503", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index 3cca60ac8f6..f5667e01e64 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -135,7 +135,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "workloadmanager.projects.locations.list", @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1248,7 +1248,7 @@ } } }, - "revision": "20260401", + "revision": "20260429", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "ActiveDirectory": { diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index a88adb44e53..85881e5d34d 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -765,7 +765,7 @@ } } }, - "revision": "20260422", + "revision": "20260510", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { @@ -851,6 +851,17 @@ }, "type": "object" }, + "DriveOptions": { + "description": "Additional supported options for serving Drive events.", + "id": "DriveOptions", + "properties": { + "includeDescendants": { + "description": "Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types).", + "type": "boolean" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1197,6 +1208,10 @@ "readOnly": true, "type": "string" }, + "driveOptions": { + "$ref": "DriveOptions", + "description": "Optional. Features that are supported only for subscriptions on Drive resources." + }, "etag": { "description": "Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.", "type": "string" diff --git a/discovery/youtubereporting-v1.json b/discovery/youtubereporting-v1.json index 32537040237..0debfbc1580 100644 --- a/discovery/youtubereporting-v1.json +++ b/discovery/youtubereporting-v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20260408", + "revision": "20260506", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { @@ -837,6 +837,11 @@ "format": "byte", "type": "string" }, + "sha512Hash": { + "description": "gdata", + "format": "byte", + "type": "string" + }, "timestamp": { "description": "gdata", "format": "uint64", diff --git a/release-please-config.json b/release-please-config.json index 815e784d85c..79f1363c465 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -326,6 +326,7 @@ "src/apis/ces": {}, "src/apis/agentregistry": {}, "src/apis/developerknowledge": {}, - "src/apis/health": {} + "src/apis/health": {}, + "src/apis/cloudnumberregistry": {} } } \ No newline at end of file diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 8506e5bb5e4..512776464f5 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -2126,7 +2126,7 @@ export namespace accesscontextmanager_v1 { } /** - * Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. + * Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. **IAM Permissions**: No specific IAM permission is required to call this method. It returns the subset of the requested permissions that the caller possesses. * @example * ```js * // Before running the sample: @@ -3251,7 +3251,7 @@ export namespace accesscontextmanager_v1 { } /** - * Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. + * Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. **IAM Permissions**: No specific IAM permission is required to call this method. It returns the subset of the requested permissions that the caller possesses. * @example * ```js * // Before running the sample: @@ -5345,7 +5345,7 @@ export namespace accesscontextmanager_v1 { } /** - * Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. + * Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. **IAM Permissions**: No specific IAM permission is required to call this method. It returns the subset of the requested permissions that the caller possesses. * @example * ```js * // Before running the sample: @@ -7197,7 +7197,7 @@ export namespace accesscontextmanager_v1 { } /** - * Returns a VPC-SC supported service based on the service name. + * Returns a VPC-SC supported service based on the service name. **IAM Permissions**: Requires the following IAM permissions to use this method: - `serviceusage.services.use` on the project. * @example * ```js * // Before running the sample: @@ -7340,7 +7340,7 @@ export namespace accesscontextmanager_v1 { } /** - * Lists all VPC-SC supported services. + * Lists all VPC-SC supported services. **IAM Permissions**: Requires the following IAM permissions to use this method: - `serviceusage.services.use` on the project. * @example * ```js * // Before running the sample: diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index b74ee832e5d..5a81f320ab6 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -1858,6 +1858,10 @@ export namespace aiplatform_v1 { */ videoDurationSeconds?: number | null; } + /** + * Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine. + */ + export interface Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse {} /** * Request message for JobService.CancelBatchPredictionJob. */ @@ -16111,7 +16115,7 @@ export namespace aiplatform_v1 { */ pickleObjectGcsUri?: string | null; /** - * Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. + * Optional. The Python version. Supported values are 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. */ pythonVersion?: string | null; /** @@ -16227,7 +16231,7 @@ export namespace aiplatform_v1 { */ requirementsFile?: string | null; /** - * Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. + * Optional. The version of Python to use. Supported versions include 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. */ version?: string | null; } @@ -17023,10 +17027,6 @@ export namespace aiplatform_v1 { * Output only. The routing token for the SandboxEnvironment. */ routingToken?: string | null; - /** - * Output only. The hostname of the SandboxEnvironment. - */ - sandboxHostname?: string | null; /** * Output only. The internal IP address of the SandboxEnvironment. */ @@ -136049,6 +136049,155 @@ export namespace aiplatform_v1 { } } + /** + * Cancels an AsyncQueryReasoningEngine operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * // Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + * operationName: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + options: StreamMethodOptions + ): Promise>; + cancelAsyncQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancelAsyncQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a reasoning engine. * @example @@ -137749,6 +137898,16 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest; } + export interface Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + /** + * Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + */ + operationName?: string; + } export interface Params$Resource$Projects$Locations$Reasoningengines$Create extends StandardParameters { /** * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` @@ -171511,6 +171670,153 @@ export namespace aiplatform_v1 { } } + /** + * Cancels an AsyncQueryReasoningEngine operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.reasoningEngines.cancelAsyncQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * // Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + * operationName: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, + options: StreamMethodOptions + ): Promise>; + cancelAsyncQuery( + params?: Params$Resource$Reasoningengines$Cancelasyncquery, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( + paramsOrCallback?: + | Params$Resource$Reasoningengines$Cancelasyncquery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reasoningengines$Cancelasyncquery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reasoningengines$Cancelasyncquery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancelAsyncQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a reasoning engine. * @example @@ -172753,6 +173059,16 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest; } + export interface Params$Resource$Reasoningengines$Cancelasyncquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + /** + * Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + */ + operationName?: string; + } export interface Params$Resource$Reasoningengines$Create extends StandardParameters { /** * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 89a8099f783..1a705d61773 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -2709,6 +2709,10 @@ export namespace androidmanagement_v1 { * Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored. */ autoDateAndTimeZone?: string | null; + /** + * Optional. The policy for the autofill service. + */ + autofillPolicy?: string | null; /** * Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored. */ @@ -7887,6 +7891,7 @@ export namespace androidmanagement_v1 { * // "assistContentPolicy": "my_assistContentPolicy", * // "autoDateAndTimeZone": "my_autoDateAndTimeZone", * // "autoTimeRequired": false, + * // "autofillPolicy": "my_autofillPolicy", * // "blockApplicationsEnabled": false, * // "bluetoothConfigDisabled": false, * // "bluetoothContactSharingDisabled": false, @@ -8425,6 +8430,7 @@ export namespace androidmanagement_v1 { * // "assistContentPolicy": "my_assistContentPolicy", * // "autoDateAndTimeZone": "my_autoDateAndTimeZone", * // "autoTimeRequired": false, + * // "autofillPolicy": "my_autofillPolicy", * // "blockApplicationsEnabled": false, * // "bluetoothConfigDisabled": false, * // "bluetoothContactSharingDisabled": false, @@ -8531,6 +8537,7 @@ export namespace androidmanagement_v1 { * // "assistContentPolicy": "my_assistContentPolicy", * // "autoDateAndTimeZone": "my_autoDateAndTimeZone", * // "autoTimeRequired": false, + * // "autofillPolicy": "my_autofillPolicy", * // "blockApplicationsEnabled": false, * // "bluetoothConfigDisabled": false, * // "bluetoothContactSharingDisabled": false, diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 21084a30289..432ddf25f52 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -621,7 +621,7 @@ export namespace androidpublisher_v3 { */ priceStepUpConsentDetails?: Schema$PriceStepUpConsentDetails; /** - * The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed. + * The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes. For tax-exclusive pricing, please call orders.get API instead if transaction details are needed. */ recurringPrice?: Schema$Money; } diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 68acf66004b..e1bda850682 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -2659,6 +2659,43 @@ export namespace backupdr_v1 { */ response?: {[key: string]: any} | null; } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. AdditionalInfo contains additional Info related to backup plan association resource. + */ + additionalInfo?: {[key: string]: string} | null; + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } /** * Point in time recovery settings of the backup configuration resource. */ @@ -2942,7 +2979,7 @@ export namespace backupdr_v1 { */ daysOfWeek?: string[] | null; /** - * Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). + * Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. */ hourlyFrequency?: number | null; /** diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index dc522f0a9bb..3b180f2dd49 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -1553,7 +1553,7 @@ export namespace batch_v1 { * * // Do the magic * const res = await batch.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1679,7 +1679,7 @@ export namespace batch_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index d89737b78ce..12e52ddfc82 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -2471,7 +2471,7 @@ export namespace beyondcorp_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -2501,7 +2501,7 @@ export namespace beyondcorp_v1 { * * // Do the magic * const res = await beyondcorp.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2635,7 +2635,7 @@ export namespace beyondcorp_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index e892f945443..e5cb2daac0b 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -4691,7 +4691,7 @@ export namespace beyondcorp_v1alpha { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -4721,7 +4721,7 @@ export namespace beyondcorp_v1alpha { * * // Do the magic * const res = await beyondcorp.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4855,7 +4855,7 @@ export namespace beyondcorp_v1alpha { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 57272f31193..555ead1bd31 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -403,6 +403,10 @@ export namespace classroom_v1 { * Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. */ id?: string | null; + /** + * Optional. Levels for the course. Examples: "9th grade", "Middle school", "4th - 5th", "K-2", "3000". If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the `PatchCourse` method. + */ + levels?: string | null; /** * Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. */ @@ -1827,6 +1831,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -1854,6 +1859,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -2140,6 +2146,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -2564,7 +2571,7 @@ export namespace classroom_v1 { * const res = await classroom.courses.patch({ * // Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. * id: 'placeholder-value', - * // Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` + * // Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` * updateMask: 'placeholder-value', * * // Request body metadata @@ -2583,6 +2590,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -2610,6 +2618,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -2713,7 +2722,7 @@ export namespace classroom_v1 { } /** - * Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl + * Updates a course. Note: Unlike other fields, `levels` is not cleared if omitted from the request. The `UpdateCourse` method only modifies `levels` if it is explicitly provided; otherwise, the existing value is preserved. Use the `PatchCourse` method to clear the `levels` field. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl * @example * ```js * // Before running the sample: @@ -2762,6 +2771,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -2789,6 +2799,7 @@ export namespace classroom_v1 { * // "gradebookSettings": {}, * // "guardiansEnabled": false, * // "id": "my_id", + * // "levels": "my_levels", * // "name": "my_name", * // "ownerId": "my_ownerId", * // "room": "my_room", @@ -3096,7 +3107,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` + * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` */ updateMask?: string; @@ -8172,6 +8183,11 @@ export namespace classroom_v1 { * scopes: [ * 'https://www.googleapis.com/auth/classroom.addons.student', * 'https://www.googleapis.com/auth/classroom.addons.teacher', + * 'https://www.googleapis.com/auth/classroom.coursework.me', + * 'https://www.googleapis.com/auth/classroom.coursework.me.readonly', + * 'https://www.googleapis.com/auth/classroom.coursework.students', + * 'https://www.googleapis.com/auth/classroom.coursework.students.readonly', + * 'https://www.googleapis.com/auth/classroom.student-submissions.me.readonly', * 'https://www.googleapis.com/auth/classroom.student-submissions.students.readonly', * ], * }); @@ -13800,6 +13816,11 @@ export namespace classroom_v1 { * scopes: [ * 'https://www.googleapis.com/auth/classroom.addons.student', * 'https://www.googleapis.com/auth/classroom.addons.teacher', + * 'https://www.googleapis.com/auth/classroom.coursework.me', + * 'https://www.googleapis.com/auth/classroom.coursework.me.readonly', + * 'https://www.googleapis.com/auth/classroom.coursework.students', + * 'https://www.googleapis.com/auth/classroom.coursework.students.readonly', + * 'https://www.googleapis.com/auth/classroom.student-submissions.me.readonly', * 'https://www.googleapis.com/auth/classroom.student-submissions.students.readonly', * ], * }); diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index ed5bd3c0707..ce77e1edb83 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -849,6 +849,10 @@ export namespace clouddeploy_v1 { * Required. Image is the container image to use. */ image?: string | null; + /** + * Optional. Shell script to execute. If provided then command and args cannot be specified. + */ + script?: string | null; } /** * A createChildRollout Job. diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 10006e81f12..1e4f0ce2381 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -199,6 +199,23 @@ export namespace cloudidentity_v1beta1 { */ verifyAppsEnabled?: boolean | null; } + /** + * Resource representing the anti-virus information of a Device. + */ + export interface Schema$AntivirusInfo { + /** + * Output only. The display name of the anti-virus software. + */ + displayName?: string | null; + /** + * Output only. The GUID of the anti-virus product. + */ + productGuid?: string | null; + /** + * Output only. The state of the anti-virus. + */ + productState?: string | null; + } /** * Request message for approving the device to access user data. */ @@ -578,6 +595,10 @@ export namespace cloudidentity_v1beta1 { * Output only. Attributes specific to Android devices. */ androidSpecificAttributes?: Schema$AndroidAttributes; + /** + * Output only. Anti-virus information for the device. + */ + antivirusInfo?: Schema$AntivirusInfo[]; /** * Asset tag of the device. */ @@ -678,6 +699,10 @@ export namespace cloudidentity_v1beta1 { * Output only. Mobile or network operator of device, if available. */ networkOperator?: string | null; + /** + * Output only. OS firewall status of the device. + */ + osFirewallStatus?: string | null; /** * Output only. OS version of the device. Example: Android 8.1.0. */ @@ -710,6 +735,10 @@ export namespace cloudidentity_v1beta1 { * WiFi MAC addresses of device. */ wifiMacAddresses?: string[] | null; + /** + * Output only. Attributes specific to Windows devices. + */ + windowsSpecificDeviceAttributes?: Schema$WindowsSpecificDeviceAttributes; } /** * Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device @@ -2381,6 +2410,27 @@ export namespace cloudidentity_v1beta1 { */ updateTime?: string | null; } + /** + * Represents the Windows specific attributes of a Device. + */ + export interface Schema$WindowsSpecificDeviceAttributes { + /** + * Output only. The hotfixes installed on the device. + */ + hotfixes?: string[] | null; + /** + * Output only. Secure boot mode of the device. + */ + secureBootMode?: string | null; + /** + * Output only. The domain of the machine that the user is logged into. This is different from the windows_user_domain as the user could be logged into a domain different from the machine domain. + */ + windowsMachineDomain?: string | null; + /** + * Output only. The domain of the user account that is logged into the machine. + */ + windowsUserDomain?: string | null; + } /** * Request message for wiping all data on the device. */ @@ -3711,6 +3761,7 @@ export namespace cloudidentity_v1beta1 { * // Example response * // { * // "androidSpecificAttributes": {}, + * // "antivirusInfo": [], * // "assetTag": "my_assetTag", * // "basebandVersion": "my_basebandVersion", * // "bootloaderVersion": "my_bootloaderVersion", @@ -3736,6 +3787,7 @@ export namespace cloudidentity_v1beta1 { * // "model": "my_model", * // "name": "my_name", * // "networkOperator": "my_networkOperator", + * // "osFirewallStatus": "my_osFirewallStatus", * // "osVersion": "my_osVersion", * // "otherAccounts": [], * // "ownerType": "my_ownerType", @@ -3743,7 +3795,8 @@ export namespace cloudidentity_v1beta1 { * // "securityPatchTime": "my_securityPatchTime", * // "serialNumber": "my_serialNumber", * // "unifiedDeviceId": "my_unifiedDeviceId", - * // "wifiMacAddresses": [] + * // "wifiMacAddresses": [], + * // "windowsSpecificDeviceAttributes": {} * // } * } * diff --git a/src/apis/cloudnumberregistry/README.md b/src/apis/cloudnumberregistry/README.md new file mode 100644 index 00000000000..2659a2d9a9c --- /dev/null +++ b/src/apis/cloudnumberregistry/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# cloudnumberregistry + +> + +## Installation + +```sh +$ npm install @googleapis/cloudnumberregistry +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/cloudnumberregistry/classes/Cloudnumberregistry.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/cloudnumberregistry/index.ts b/src/apis/cloudnumberregistry/index.ts new file mode 100644 index 00000000000..d91fd9ab05d --- /dev/null +++ b/src/apis/cloudnumberregistry/index.ts @@ -0,0 +1,49 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {cloudnumberregistry_v1alpha} from './v1alpha'; + +export const VERSIONS = { + v1alpha: cloudnumberregistry_v1alpha.Cloudnumberregistry, +}; + +export function cloudnumberregistry( + version: 'v1alpha' +): cloudnumberregistry_v1alpha.Cloudnumberregistry; +export function cloudnumberregistry( + options: cloudnumberregistry_v1alpha.Options +): cloudnumberregistry_v1alpha.Cloudnumberregistry; +export function cloudnumberregistry< + T = cloudnumberregistry_v1alpha.Cloudnumberregistry, +>( + this: GoogleConfigurable, + versionOrOptions: 'v1alpha' | cloudnumberregistry_v1alpha.Options +) { + return getAPI('cloudnumberregistry', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {cloudnumberregistry_v1alpha}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/cloudnumberregistry/package.json b/src/apis/cloudnumberregistry/package.json new file mode 100644 index 00000000000..ce470697fec --- /dev/null +++ b/src/apis/cloudnumberregistry/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/cloudnumberregistry", + "version": "0.1.0", + "description": "cloudnumberregistry", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^8.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^6.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "5.7.3", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/cloudnumberregistry/tsconfig.json b/src/apis/cloudnumberregistry/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/cloudnumberregistry/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/cloudnumberregistry/v1alpha.ts b/src/apis/cloudnumberregistry/v1alpha.ts new file mode 100644 index 00000000000..ad673790393 --- /dev/null +++ b/src/apis/cloudnumberregistry/v1alpha.ts @@ -0,0 +1,6880 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosResponseWithHTTP2, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace cloudnumberregistry_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Number Registry API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * ``` + */ + export class Cloudnumberregistry { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Aggregated data for the RegistryBook. + */ + export interface Schema$AggregatedData { + /** + * Output only. Number of custom ranges in the RegistryBook. + */ + customRangesCount?: number | null; + /** + * Output only. Number of custom realms in the RegistryBook. + */ + customRealmsCount?: number | null; + /** + * Output only. Number of discovered ranges in the RegistryBook. + */ + discoveredRangesCount?: number | null; + /** + * Output only. Number of discovered realms in the RegistryBook. + */ + discoveredRealmsCount?: number | null; + /** + * Output only. Number of scopes unique to the RegistryBook. + */ + uniqueScopesCount?: number | null; + } + /** + * Message describing Attribute object + */ + export interface Schema$Attribute { + /** + * Required. Key of attribute + */ + key?: string | null; + /** + * Required. Value of attribute + */ + value?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Message for response to checking the availability of IpamAdminScopes + */ + export interface Schema$CheckAvailabilityIpamAdminScopesResponse { + /** + * The details of the requested scopes. + */ + scopeAvailabilities?: Schema$IpamAdminScopeAvailability[]; + } + /** + * Message for cleaning up a IpamAdminScope + */ + export interface Schema$CleanupIpamAdminScopeRequest { + /** + * Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + */ + requestId?: string | null; + } + /** + * Message describing CustomRange object + */ + export interface Schema$CustomRange { + /** + * Optional. The attributes of the CustomRange. + */ + attributes?: Schema$Attribute[]; + /** + * Optional. Description of the CustomRange. + */ + description?: string | null; + /** + * Optional. The IPv4 CIDR range of the CustomRange. + */ + ipv4CidrRange?: string | null; + /** + * Optional. The IPv6 CIDR range of the CustomRange. + */ + ipv6CidrRange?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. name of resource + */ + name?: string | null; + /** + * Optional. The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project\}/locations/{location\}/customRanges/{custom_range\} + */ + parentRange?: string | null; + /** + * Optional. The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project\}/locations/{location\}/realms/{realm\} + */ + realm?: string | null; + /** + * Output only. The registry book of the CustomRange. This field is inherited from the realm or parent range depending on which one is specified. + */ + registryBook?: string | null; + } + /** + * Message for disabling a IpamAdminScope + */ + export interface Schema$DisableIpamAdminScopeRequest { + /** + * Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + */ + requestId?: string | null; + } + /** + * Message describing DiscoveredRange object + */ + export interface Schema$DiscoveredRange { + /** + * Optional. The attributes of the DiscoveredRange. + */ + attributes?: Schema$Attribute[]; + /** + * Output only. If true, allow child ranges of this range to overlap with each other. + */ + childCidrOverlapAllowed?: boolean | null; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Optional. Description of the DiscoveredRange. + */ + description?: string | null; + /** + * Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time. + */ + discoveryMetadata?: Schema$DiscoveryMetadata; + /** + * Optional. The IPv4 CIDR range of the DiscoveredRange. + */ + ipv4CidrRange?: string | null; + /** + * Optional. The IPv6 CIDR range of the DiscoveredRange. + */ + ipv6CidrRange?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. Name of the DiscoveredRange. + */ + name?: string | null; + /** + * Optional. The parent range of the DiscoveredRange. + */ + parentRange?: string | null; + /** + * Optional. The realm of the DiscoveredRange. + */ + realm?: string | null; + /** + * Output only. The registry book of the DiscoveredRange. + */ + registryBook?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Discovery metadata of the discovered resource. + */ + export interface Schema$DiscoveryMetadata { + /** + * Output only. The time when the resource was created. + */ + createTime?: string | null; + /** + * Output only. The time when the event happened. + */ + eventTime?: string | null; + /** + * Output only. The resource name of the discovered resource, should be API-agnostic. Example: "projects/{project_number\}/networks/{network_id\}". + */ + resource?: string | null; + /** + * Output only. The resource uri of the discovered resource. + */ + resourceUri?: string | null; + /** + * Output only. The canonical google.aip.dev/122 name of the source resource. + */ + sourceId?: string | null; + /** + * Output only. A single source resource can be the source of multiple CNR resources. This sub_id is used to distinguish between the different CNR resources derived from the same upstream resource. For example, a single subnetwork can be the source of multiple ranges, one for each protocol. In this case, the sub_id could be "private-ipv4" or "private-ipv6". + */ + sourceSubId?: string | null; + /** + * Output only. The state of the resource. + */ + state?: string | null; + /** + * Output only. The time when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * Message for the response to finding free IP ranges. + */ + export interface Schema$FindCustomRangeFreeIpRangesResponse { + /** + * Output only. Free IP CIDR ranges found in the CustomRange. + */ + freeIpCidrRanges?: string[] | null; + } + /** + * Message for the response to finding free IP ranges. + */ + export interface Schema$FindDiscoveredRangeFreeIpRangesResponse { + /** + * Output only. Free IP CIDR ranges found in the DiscoveredRange. + */ + freeIpCidrRanges?: string[] | null; + } + /** + * Message describing IpamAdminScope object + */ + export interface Schema$IpamAdminScope { + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Required. Addon platforms that are enabled for this IPAM admin scope. Cloud Number Registry only discovers the IP addresses from the enabled platforms. + */ + enabledAddonPlatforms?: string[] | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. name of resource + */ + name?: string | null; + /** + * Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed. + */ + scopes?: string[] | null; + /** + * Output only. State of resource discovery pipeline. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Message for the availability of an IpamAdminScope + */ + export interface Schema$IpamAdminScopeAvailability { + /** + * The admin project of the IpamAdminScope if it exists. + */ + adminProject?: string | null; + /** + * The availability of the scope. + */ + availability?: string | null; + /** + * The scope of the IpamAdminScope. + */ + scope?: string | null; + } + /** + * Message for response to listing CustomRanges + */ + export interface Schema$ListCustomRangesResponse { + /** + * The list of CustomRange + */ + customRanges?: Schema$CustomRange[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing DiscoveredRanges + */ + export interface Schema$ListDiscoveredRangesResponse { + /** + * The list of DiscoveredRange + */ + discoveredRanges?: Schema$DiscoveredRange[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing ipamAdminScopes + */ + export interface Schema$ListIpamAdminScopesResponse { + /** + * The list of IpamAdminScope + */ + ipamAdminScopes?: Schema$IpamAdminScope[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing Realms + */ + export interface Schema$ListRealmsResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of Realm + */ + realms?: Schema$Realm[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing RegistryBooks + */ + export interface Schema$ListRegistryBooksResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of RegistryBook + */ + registryBooks?: Schema$RegistryBook[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Message describing either a CustomRange or a DiscoveredRange. + */ + export interface Schema$Range { + /** + * A custom range. + */ + customRange?: Schema$CustomRange; + /** + * A discovered range. + */ + discoveredRange?: Schema$DiscoveredRange; + /** + * The utilization of the range. + */ + utilization?: Schema$RangeUtilization; + } + /** + * Message for the utilization of an IP range + */ + export interface Schema$RangeUtilization { + /** + * Output only. The total number of IP addresses consumed in the range. + */ + totalConsumed?: string | null; + /** + * Output only. The total number of IP addresses produced in the range. + */ + totalProduced?: string | null; + /** + * Output only. The usage of the range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL. + */ + usage?: number | null; + } + /** + * Message describing Realm object + */ + export interface Schema$Realm { + /** + * Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE. + */ + aggregatedData?: Schema$RealmAggregatedData; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Output only. Discovery metadata of the realm. + */ + discoveryMetadata?: Schema$DiscoveryMetadata; + /** + * Optional. IP version of the realm. + */ + ipVersion?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Management type of realm. + */ + managementType?: string | null; + /** + * Required. Identifier. Unique name/ID of the realm + */ + name?: string | null; + /** + * Required. URI of the registry book that claims the realm. + */ + registryBook?: string | null; + /** + * Required. Traffic type of realm. + */ + trafficType?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Aggregated data for the Realm. + */ + export interface Schema$RealmAggregatedData { + /** + * Output only. Number of custom ranges in the Realm. + */ + customRangesCount?: number | null; + /** + * Output only. Number of discovered ranges in the Realm. + */ + discoveredRangesCount?: number | null; + } + /** + * Message describing RegistryBook object + */ + export interface Schema$RegistryBook { + /** + * Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE. + */ + aggregatedData?: Schema$AggregatedData; + /** + * Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project\}. Each scope can only be claimed once. + */ + claimedScopes?: string[] | null; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Output only. Whether the RegistryBook is the default one. + */ + isDefault?: boolean | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. name of resource + */ + name?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Message for searching IP resources + */ + export interface Schema$SearchIpResourcesRequest { + /** + * Optional. Hint for how to order the results + */ + orderBy?: string | null; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number | null; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string | null; + /** + * Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - `realm`: The realm name to search in. - `ip_address`: The IP address to search for within ranges. - `ip_version`: The IP version to filter by (e.g., "IPV4", "IPV6"). - `parent_range`: The parent range of the range to search for. - `attribute_text`: The attribute text to search for within ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for realms are: - `ip_version`: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` + */ + query?: string | null; + /** + * Optional. The type of resources to search for. If not specified, the server will return ranges. + */ + searchResourceTypes?: string[] | null; + /** + * Optional. Whether to show the utilization of the ranges in the response. + */ + showUtilization?: boolean | null; + } + /** + * Message for response to searching IP resources + */ + export interface Schema$SearchIpResourcesResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Deprecated: Use results field instead. The list of ranges matching the search query. + */ + ranges?: Schema$Range[]; + /** + * The list of results matching the search query. + */ + results?: Schema$SearchIpResourcesResult[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A result matching the search query, which can be either a range or a realm. + */ + export interface Schema$SearchIpResourcesResult { + /** + * A range matching the search query. + */ + range?: Schema$Range; + /** + * A realm matching the search query. + */ + realm?: Schema$Realm; + } + /** + * Message for the response to getting the utilization of a CustomRange + */ + export interface Schema$ShowCustomRangeUtilizationResponse { + /** + * The CustomRange resource. + */ + customRange?: Schema$CustomRange; + /** + * The utilization of the CustomRange. + */ + rangeUtilization?: Schema$RangeUtilization; + } + /** + * Message for the response to getting the utilization of a DiscoveredRange + */ + export interface Schema$ShowDiscoveredRangeUtilizationResponse { + /** + * The DiscoveredRange resource. + */ + discoveredRange?: Schema$DiscoveredRange; + /** + * The utilization of the DiscoveredRange. + */ + rangeUtilization?: Schema$RangeUtilization; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + customRanges: Resource$Projects$Locations$Customranges; + discoveredRanges: Resource$Projects$Locations$Discoveredranges; + ipamAdminScopes: Resource$Projects$Locations$Ipamadminscopes; + operations: Resource$Projects$Locations$Operations; + realms: Resource$Projects$Locations$Realms; + registryBooks: Resource$Projects$Locations$Registrybooks; + constructor(context: APIRequestContext) { + this.context = context; + this.customRanges = new Resource$Projects$Locations$Customranges( + this.context + ); + this.discoveredRanges = new Resource$Projects$Locations$Discoveredranges( + this.context + ); + this.ipamAdminScopes = new Resource$Projects$Locations$Ipamadminscopes( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.realms = new Resource$Projects$Locations$Realms(this.context); + this.registryBooks = new Resource$Projects$Locations$Registrybooks( + this.context + ); + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.list({ + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Customranges { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new CustomRange in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.create({ + * // Required. Id of the requesting object. + * customRangeId: 'placeholder-value', + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": [], + * // "description": "my_description", + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Customranges$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/customRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.delete({ + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * // Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Customranges$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Finds free IP ranges in a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges({ + * // Required. The prefix length of the free IP ranges to find. + * cidrPrefixLength: 'placeholder-value', + * // Required. Name of the CustomRange. + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * // Optional. The number of free IP ranges to find. + * rangeCount: 'placeholder-value', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "freeIpCidrRanges": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options: StreamMethodOptions + ): Promise>; + findFreeIpRanges( + params?: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Findfreeipranges + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Findfreeipranges; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customranges$Findfreeipranges; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:findFreeIpRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "attributes": [], + * // "description": "my_description", + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Customranges$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists CustomRanges in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.list({ + * // Optional. Filtering results. + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListCustomRangesRequest + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "customRanges": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Customranges$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Customranges$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Customranges$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customranges$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customranges$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/customRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.patch({ + * // Required. Identifier. name of resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": [], + * // "description": "my_description", + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Customranges$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the details of a single CustomRange and its utilization. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.customRanges.showUtilization({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "customRange": {}, + * // "rangeUtilization": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + options: StreamMethodOptions + ): Promise>; + showUtilization( + params?: Params$Resource$Projects$Locations$Customranges$Showutilization, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + callback: BodyResponseCallback + ): void; + showUtilization( + callback: BodyResponseCallback + ): void; + showUtilization( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Showutilization + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Showutilization; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customranges$Showutilization; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:showUtilization').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Customranges$Create extends StandardParameters { + /** + * Required. Id of the requesting object. + */ + customRangeId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomRange; + } + export interface Params$Resource$Projects$Locations$Customranges$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$Findfreeipranges extends StandardParameters { + /** + * Required. The prefix length of the free IP ranges to find. + */ + cidrPrefixLength?: number; + /** + * Required. Name of the CustomRange. + */ + name?: string; + /** + * Optional. The number of free IP ranges to find. + */ + rangeCount?: number; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$List extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListCustomRangesRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$Patch extends StandardParameters { + /** + * Required. Identifier. name of resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomRange; + } + export interface Params$Resource$Projects$Locations$Customranges$Showutilization extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + + export class Resource$Projects$Locations$Discoveredranges { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Finds free IP ranges in a single DiscoveredRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges( + * { + * // Required. The prefix length of the free IP ranges to find. + * cidrPrefixLength: 'placeholder-value', + * // Required. Name of the DiscoveredRange. + * name: 'projects/my-project/locations/my-location/discoveredRanges/my-discoveredRange', + * // Optional. The number of free IP ranges to find. + * rangeCount: 'placeholder-value', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "freeIpCidrRanges": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options: StreamMethodOptions + ): Promise>; + findFreeIpRanges( + params?: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:findFreeIpRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a single DiscoveredRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.discoveredRanges.get( + * { + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/discoveredRanges/my-discoveredRange', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "attributes": [], + * // "childCidrOverlapAllowed": false, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "discoveryMetadata": {}, + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Discoveredranges$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Discoveredranges$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists DiscoveredRanges in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.discoveredRanges.list({ + * // Optional. Filtering results. + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListDiscoveredRangesRequest + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "discoveredRanges": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Discoveredranges$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Discoveredranges$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/discoveredRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the details of a single DiscoveredRange and its utilization. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.discoveredRanges.showUtilization( + * { + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/discoveredRanges/my-discoveredRange', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "discoveredRange": {}, + * // "rangeUtilization": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options: StreamMethodOptions + ): Promise>; + showUtilization( + params?: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + callback: BodyResponseCallback + ): void; + showUtilization( + callback: BodyResponseCallback + ): void; + showUtilization( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$Showutilization + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$Showutilization; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredranges$Showutilization; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:showUtilization').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges extends StandardParameters { + /** + * Required. The prefix length of the free IP ranges to find. + */ + cidrPrefixLength?: number; + /** + * Required. Name of the DiscoveredRange. + */ + name?: string; + /** + * Optional. The number of free IP ranges to find. + */ + rangeCount?: number; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredranges$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredranges$List extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListDiscoveredRangesRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredranges$Showutilization extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + + export class Resource$Projects$Locations$Ipamadminscopes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Checks the availability of IPAM admin scopes in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability( + * { + * // Required. Parent value for the IpamAdminScopes. + * parent: 'projects/my-project/locations/my-location', + * // Required. The scopes of the IpamAdminScopes to look for. + * scopes: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "scopeAvailabilities": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options: StreamMethodOptions + ): Promise>; + checkAvailability( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + callback: BodyResponseCallback + ): void; + checkAvailability( + callback: BodyResponseCallback + ): void; + checkAvailability( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/ipamAdminScopes:checkAvailability' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Cleans up a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requestId": "my_requestId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options: StreamMethodOptions + ): Promise>; + cleanup( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options?: MethodOptions + ): Promise>; + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + callback: BodyResponseCallback + ): void; + cleanup(callback: BodyResponseCallback): void; + cleanup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:cleanup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new IpamAdminScope in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.create({ + * // Required. Id of the requesting object. + * ipamAdminScopeId: 'placeholder-value', + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "enabledAddonPlatforms": [], + * // "labels": {}, + * // "name": "my_name", + * // "scopes": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/ipamAdminScopes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.delete({ + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * // Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.disable({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requestId": "my_requestId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options: StreamMethodOptions + ): Promise>; + disable( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options?: MethodOptions + ): Promise>; + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + callback: BodyResponseCallback + ): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Disable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.ipamAdminScopes.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "enabledAddonPlatforms": [], + * // "labels": {}, + * // "name": "my_name", + * // "scopes": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ipamadminscopes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List all IPAM admin scopes in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.ipamAdminScopes.list( + * { + * // Optional. Filtering results + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListIpamAdminScopesRequest + * parent: 'projects/my-project/locations/my-location', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ipamAdminScopes": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ipamadminscopes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/ipamAdminScopes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.patch({ + * // Required. Identifier. name of resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "enabledAddonPlatforms": [], + * // "labels": {}, + * // "name": "my_name", + * // "scopes": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ipamadminscopes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability extends StandardParameters { + /** + * Required. Parent value for the IpamAdminScopes. + */ + parent?: string; + /** + * Required. The scopes of the IpamAdminScopes to look for. + */ + scopes?: string[]; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CleanupIpamAdminScopeRequest; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Create extends StandardParameters { + /** + * Required. Id of the requesting object. + */ + ipamAdminScopeId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IpamAdminScope; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Disable extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableIpamAdminScopeRequest; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$List extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Hint for how to order the results + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListIpamAdminScopesRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Patch extends StandardParameters { + /** + * Required. Identifier. name of resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IpamAdminScope; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Realms { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Realm in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.create({ + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Required. Id of the requesting object. + * realmId: 'placeholder-value', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "createTime": "my_createTime", + * // "discoveryMetadata": {}, + * // "ipVersion": "my_ipVersion", + * // "labels": {}, + * // "managementType": "my_managementType", + * // "name": "my_name", + * // "registryBook": "my_registryBook", + * // "trafficType": "my_trafficType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Realms$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Realms$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Realms$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Realms$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Realms$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/realms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Realm. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.delete({ + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/realms/my-realm', + * // Optional. 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. The server will guarantee that for at least 60 minutes after the first request. + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Realms$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Realm. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/realms/my-realm', + * // Optional. The view of the Realm. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "aggregatedData": {}, + * // "createTime": "my_createTime", + * // "discoveryMetadata": {}, + * // "ipVersion": "my_ipVersion", + * // "labels": {}, + * // "managementType": "my_managementType", + * // "name": "my_name", + * // "registryBook": "my_registryBook", + * // "trafficType": "my_trafficType", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Realms$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Realms$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Realms$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Realms$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Realms$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Realms in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.list({ + * // Optional. Filtering results + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListRealmsRequest + * parent: 'projects/my-project/locations/my-location', + * // Optional. The view of the Realm. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "realms": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Realms$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Realms$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Realms$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Realms$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Realms$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/realms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single Realm. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.patch({ + * // Required. Identifier. Unique name/ID of the realm + * name: 'projects/my-project/locations/my-location/realms/my-realm', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "createTime": "my_createTime", + * // "discoveryMetadata": {}, + * // "ipVersion": "my_ipVersion", + * // "labels": {}, + * // "managementType": "my_managementType", + * // "name": "my_name", + * // "registryBook": "my_registryBook", + * // "trafficType": "my_trafficType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Realms$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Realms$Create extends StandardParameters { + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Required. Id of the requesting object. + */ + realmId?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Realm; + } + export interface Params$Resource$Projects$Locations$Realms$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes after the first request. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Realms$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. The view of the Realm. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Realms$List extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Hint for how to order the results + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListRealmsRequest + */ + parent?: string; + /** + * Optional. The view of the Realm. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Realms$Patch extends StandardParameters { + /** + * Required. Identifier. Unique name/ID of the realm + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Realm; + } + + export class Resource$Projects$Locations$Registrybooks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new RegistryBook in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.create( + * { + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Required. Id of the requesting object. + * registryBookId: 'placeholder-value', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "claimedScopes": [], + * // "createTime": "my_createTime", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Registrybooks$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/registryBooks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.delete( + * { + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * // Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + * requestId: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Registrybooks$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * // Optional. The view of the RegistryBook. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "aggregatedData": {}, + * // "claimedScopes": [], + * // "createTime": "my_createTime", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Registrybooks$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists RegistryBooks in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.list({ + * // Optional. Filtering results + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListRegistryBooksRequest + * parent: 'projects/my-project/locations/my-location', + * // Optional. The view of the RegistryBook. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "registryBooks": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Registrybooks$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/registryBooks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.patch({ + * // Required. Identifier. name of resource + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * // Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "claimedScopes": [], + * // "createTime": "my_createTime", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Registrybooks$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Searches IP resources in a given RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.registryBooks.searchIpResources( + * { + * // Required. The name of the RegistryBook to search in. + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "query": "my_query", + * // "searchResourceTypes": [], + * // "showUtilization": false + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "ranges": [], + * // "results": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options: StreamMethodOptions + ): Promise>; + searchIpResources( + params?: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options?: MethodOptions + ): Promise>; + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + callback: BodyResponseCallback + ): void; + searchIpResources( + callback: BodyResponseCallback + ): void; + searchIpResources( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Searchipresources + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Searchipresources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Registrybooks$Searchipresources; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:searchIpResources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Registrybooks$Create extends StandardParameters { + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Required. Id of the requesting object. + */ + registryBookId?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegistryBook; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. The view of the RegistryBook. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Registrybooks$List extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Hint for how to order the results + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListRegistryBooksRequest + */ + parent?: string; + /** + * Optional. The view of the RegistryBook. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Patch extends StandardParameters { + /** + * Required. Identifier. name of resource + */ + name?: string; + /** + * Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegistryBook; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Searchipresources extends StandardParameters { + /** + * Required. The name of the RegistryBook to search in. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchIpResourcesRequest; + } +} diff --git a/src/apis/cloudnumberregistry/webpack.config.js b/src/apis/cloudnumberregistry/webpack.config.js new file mode 100644 index 00000000000..dc6b76aa210 --- /dev/null +++ b/src/apis/cloudnumberregistry/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Cloudnumberregistry', + filename: 'cloudnumberregistry.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 60aad9c69fe..784fe6156bd 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -14800,6 +14800,11 @@ export namespace compute_alpha { * example `n2-standard-4` and not URLs or partial URLs. */ machineTypes?: string[] | null; + /** + * Name of the minimum CPU platform to be used by this instance selection. + * e.g. 'Intel Ice Lake'. + */ + minCpuPlatform?: string | null; /** * Rank when prioritizing the shape flexibilities. * The instance selections with rank are considered diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index dc2673ce066..5db769f3d6a 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -136,6 +136,10 @@ export namespace containeranalysis_v1 { * Findings produced by the analysis. */ findings?: Schema$Finding[]; + /** + * Maximum severity found among findings. + */ + maxSeverity?: string | null; /** * Name of the skill that produced this analysis. */ @@ -2145,29 +2149,30 @@ export namespace containeranalysis_v1 { */ category?: string | null; /** - * Detailed description of the finding. - */ - description?: string | null; - /** - * Path to the file where the finding was detected. + * Location (path and line) where the finding was detected. */ - filePath?: string | null; + location?: Schema$FindingLocation; /** - * Unique identifier of the rule that produced this finding. + * Scanner determines which engine (e.g. static, llm) emitted the finding. */ - ruleId?: string | null; + scanner?: string | null; /** * Severity of the finding. */ severity?: string | null; + } + /** + * Location details with file path and line number. + */ + export interface Schema$FindingLocation { /** - * Code snippet relevant to the finding. + * Relative path of the file containing the finding. */ - snippet?: string | null; + filePath?: string | null; /** - * Title of the finding. + * Line number (1-based), or 0 if whole File / unknown. */ - title?: string | null; + lineNumber?: string | null; } /** * A set of properties that uniquely identify a given Docker image. diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index f39639b7985..023b2c20d05 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -138,6 +138,10 @@ export namespace containeranalysis_v1alpha1 { * Optional. Findings produced by the analysis. */ findings?: Schema$Finding[]; + /** + * Optional. Maximum severity found among findings. + */ + maxSeverity?: string | null; /** * Optional. Name of the skill that produced this analysis. */ @@ -1785,51 +1789,79 @@ export namespace containeranalysis_v1alpha1 { operationId?: string | null; } /** - * Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator + * Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator */ export interface Schema$CVSS { /** - * Defined in CVSS v3, CVSS v2 + * Optional. Attack Complexity (AC). Defined in CVSS v2, v3, v4. */ attackComplexity?: string | null; /** - * Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 + * Optional. Attack Requirements (AT). Defined in CVSS v4. + */ + attackRequirements?: string | null; + /** + * Optional. Attack Vector (AV). Defined in CVSS v2, v3, v4. */ attackVector?: string | null; /** - * Defined in CVSS v2 + * Optional. Authentication (Au). Defined in CVSS v2. */ authentication?: string | null; /** - * Defined in CVSS v3, CVSS v2 + * Optional. Availability Impact (A). Defined in CVSS v2, v3. */ availabilityImpact?: string | null; /** - * The base score is a function of the base metric scores. + * Optional. The base score is a function of the base metric scores. */ baseScore?: number | null; /** - * Defined in CVSS v3, CVSS v2 + * Optional. Confidentiality Impact (C). Defined in CVSS v2, v3. */ confidentialityImpact?: string | null; exploitabilityScore?: number | null; impactScore?: number | null; /** - * Defined in CVSS v3, CVSS v2 + * Optional. Integrity Impact (I). Defined in CVSS v2, v3. */ integrityImpact?: string | null; /** - * Defined in CVSS v3 + * Optional. Privileges Required (PR). Defined in CVSS v3, v4. */ privilegesRequired?: string | null; /** - * Defined in CVSS v3 + * Optional. Scope (S). Defined in CVSS v3. */ scope?: string | null; /** - * Defined in CVSS v3 + * Optional. Subsequent System Availability Impact (SA). Defined in CVSS v4. + */ + subsequentSystemAvailabilityImpact?: string | null; + /** + * Optional. Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + */ + subsequentSystemConfidentialityImpact?: string | null; + /** + * Optional. Subsequent System Integrity Impact (SI). Defined in CVSS v4. + */ + subsequentSystemIntegrityImpact?: string | null; + /** + * Optional. User Interaction (UI). Defined in CVSS v3, v4. */ userInteraction?: string | null; + /** + * Optional. Vulnerable System Availability Impact (VA). Defined in CVSS v4. + */ + vulnerableSystemAvailabilityImpact?: string | null; + /** + * Optional. Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + */ + vulnerableSystemConfidentialityImpact?: string | null; + /** + * Optional. Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + */ + vulnerableSystemIntegrityImpact?: string | null; } /** * An artifact that can be deployed in some runtime. @@ -2324,29 +2356,30 @@ export namespace containeranalysis_v1alpha1 { */ category?: string | null; /** - * Optional. Detailed description of the finding. - */ - description?: string | null; - /** - * Optional. Path to the file where the finding was detected. + * Optional. Location (path and line) where the finding was detected. */ - filePath?: string | null; + location?: Schema$FindingLocation; /** - * Optional. Unique identifier of the rule that produced this finding. + * Optional. Scanner determines which engine (e.g. static, llm) emitted the finding. */ - ruleId?: string | null; + scanner?: string | null; /** * Optional. Severity of the finding. */ severity?: string | null; + } + /** + * Location details with file path and line number. + */ + export interface Schema$FindingLocation { /** - * Optional. Code snippet relevant to the finding. + * Optional. Relative path of the file containing the finding. */ - snippet?: string | null; + filePath?: string | null; /** - * Optional. Title of the finding. + * Optional. Line number (1-based), or 0 if whole File / unknown. */ - title?: string | null; + lineNumber?: string | null; } /** * A set of properties that uniquely identify a given Docker image. diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index c844814a906..334d6623432 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -136,6 +136,10 @@ export namespace containeranalysis_v1beta1 { * Findings produced by the analysis. */ findings?: Schema$Finding[]; + /** + * Maximum severity found among findings. + */ + maxSeverity?: string | null; /** * Name of the skill that produced this analysis. */ @@ -2188,29 +2192,30 @@ export namespace containeranalysis_v1beta1 { */ category?: string | null; /** - * Detailed description of the finding. - */ - description?: string | null; - /** - * Path to the file where the finding was detected. + * Location (path and line) where the finding was detected. */ - filePath?: string | null; + location?: Schema$FindingLocation; /** - * Unique identifier of the rule that produced this finding. + * Scanner determines which engine (e.g. static, llm) emitted the finding. */ - ruleId?: string | null; + scanner?: string | null; /** * Severity of the finding. */ severity?: string | null; + } + /** + * Location details with file path and line number. + */ + export interface Schema$FindingLocation { /** - * Code snippet relevant to the finding. + * Relative path of the file containing the finding. */ - snippet?: string | null; + filePath?: string | null; /** - * Title of the finding. + * Line number (1-based), or 0 if whole File / unknown. */ - title?: string | null; + lineNumber?: string | null; } /** * A set of properties that uniquely identify a given Docker image. diff --git a/src/apis/dataform/v1.ts b/src/apis/dataform/v1.ts index 6b2f868757c..450ceeb7b76 100644 --- a/src/apis/dataform/v1.ts +++ b/src/apis/dataform/v1.ts @@ -420,7 +420,7 @@ export namespace dataform_v1 { */ export interface Schema$CompilationError { /** - * Output only. The identifier of the action where this error occurred, if available. + * Output only. The identifier of the action where this error occurred, if available. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CompilationError) */ actionTarget?: Schema$Target; /** @@ -991,7 +991,7 @@ export namespace dataform_v1 { */ nextPageToken?: string | null; /** - * Locations which could not be reached. + * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse) */ unreachable?: string[] | null; } @@ -1038,7 +1038,7 @@ export namespace dataform_v1 { */ releaseConfigs?: Schema$ReleaseConfig[]; /** - * Locations which could not be reached. + * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse) */ unreachable?: string[] | null; } @@ -1251,7 +1251,7 @@ export namespace dataform_v1 { */ contents?: string | null; /** - * Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run. + * Output only. The ID of the Gemini Enterprise Agent Platform job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run. */ jobId?: string | null; } @@ -1652,7 +1652,7 @@ export namespace dataform_v1 { */ gitCommitish?: string | null; /** - * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ReleaseConfig) */ internalMetadata?: string | null; /** @@ -2535,7 +2535,7 @@ export namespace dataform_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -2568,7 +2568,7 @@ export namespace dataform_v1 { * * // Do the magic * const res = await dataform.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3006,7 +3006,7 @@ export namespace dataform_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -8045,7 +8045,7 @@ export namespace dataform_v1 { * // Do the magic * const res = * await dataform.projects.locations.repositories.compilationResults.get({ - * // Required. The compilation result's name. + * // Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest) * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', * }); * console.log(res.data); @@ -8195,7 +8195,7 @@ export namespace dataform_v1 { * // Do the magic * const res = * await dataform.projects.locations.repositories.compilationResults.list({ - * // Optional. Filter for the returned list. + * // Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest) * filter: 'placeholder-value', * // Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. * orderBy: 'placeholder-value', @@ -8489,13 +8489,13 @@ export namespace dataform_v1 { } export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get extends StandardParameters { /** - * Required. The compilation result's name. + * Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest) */ name?: string; } export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List extends StandardParameters { /** - * Optional. Filter for the returned list. + * Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest) */ filter?: string; /** @@ -8578,7 +8578,7 @@ export namespace dataform_v1 { * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`. * parent: * 'projects/my-project/locations/my-location/repositories/my-repositorie', - * // Required. The ID to use for the release config, which will become the final component of the release config's resource name. + * // Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) * releaseConfigId: 'placeholder-value', * * // Request body metadata @@ -8744,7 +8744,7 @@ export namespace dataform_v1 { * // Do the magic * const res = * await dataform.projects.locations.repositories.releaseConfigs.delete({ - * // Required. The release config's name. + * // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest) * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', * }); * console.log(res.data); @@ -8881,7 +8881,7 @@ export namespace dataform_v1 { * // Do the magic * const res = await dataform.projects.locations.repositories.releaseConfigs.get( * { - * // Required. The release config's name. + * // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest) * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', * }, * ); @@ -9031,7 +9031,7 @@ export namespace dataform_v1 { * await dataform.projects.locations.repositories.releaseConfigs.list({ * // Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest) * pageToken: 'placeholder-value', * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. * parent: @@ -9319,7 +9319,7 @@ export namespace dataform_v1 { */ parent?: string; /** - * Required. The ID to use for the release config, which will become the final component of the release config's resource name. + * Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) */ releaseConfigId?: string; @@ -9330,13 +9330,13 @@ export namespace dataform_v1 { } export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete extends StandardParameters { /** - * Required. The release config's name. + * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest) */ name?: string; } export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get extends StandardParameters { /** - * Required. The release config's name. + * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest) */ name?: string; } @@ -9346,7 +9346,7 @@ export namespace dataform_v1 { */ pageSize?: number; /** - * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest) */ pageToken?: string; /** diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index f1ff625797b..6b385e7e249 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -420,7 +420,7 @@ export namespace dataform_v1beta1 { */ export interface Schema$CompilationError { /** - * Output only. The identifier of the action where this error occurred, if available. + * Output only. The identifier of the action where this error occurred, if available. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CompilationError) */ actionTarget?: Schema$Target; /** @@ -991,7 +991,7 @@ export namespace dataform_v1beta1 { */ nextPageToken?: string | null; /** - * Locations which could not be reached. + * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse) */ unreachable?: string[] | null; } @@ -1038,7 +1038,7 @@ export namespace dataform_v1beta1 { */ releaseConfigs?: Schema$ReleaseConfig[]; /** - * Locations which could not be reached. + * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse) */ unreachable?: string[] | null; } @@ -1251,7 +1251,7 @@ export namespace dataform_v1beta1 { */ contents?: string | null; /** - * Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run. + * Output only. The ID of the Gemini Enterprise Agent Platform job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run. */ jobId?: string | null; } @@ -1652,7 +1652,7 @@ export namespace dataform_v1beta1 { */ gitCommitish?: string | null; /** - * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ReleaseConfig) */ internalMetadata?: string | null; /** @@ -2535,7 +2535,7 @@ export namespace dataform_v1beta1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -2568,7 +2568,7 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = await dataform.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3005,7 +3005,7 @@ export namespace dataform_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -8061,7 +8061,7 @@ export namespace dataform_v1beta1 { * // Do the magic * const res = * await dataform.projects.locations.repositories.compilationResults.get({ - * // Required. The compilation result's name. + * // Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest) * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', * }); * console.log(res.data); @@ -8211,7 +8211,7 @@ export namespace dataform_v1beta1 { * // Do the magic * const res = * await dataform.projects.locations.repositories.compilationResults.list({ - * // Optional. Filter for the returned list. + * // Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest) * filter: 'placeholder-value', * // Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. * orderBy: 'placeholder-value', @@ -8508,13 +8508,13 @@ export namespace dataform_v1beta1 { } export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get extends StandardParameters { /** - * Required. The compilation result's name. + * Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest) */ name?: string; } export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List extends StandardParameters { /** - * Optional. Filter for the returned list. + * Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest) */ filter?: string; /** @@ -8597,7 +8597,7 @@ export namespace dataform_v1beta1 { * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`. * parent: * 'projects/my-project/locations/my-location/repositories/my-repositorie', - * // Required. The ID to use for the release config, which will become the final component of the release config's resource name. + * // Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) * releaseConfigId: 'placeholder-value', * * // Request body metadata @@ -8763,7 +8763,7 @@ export namespace dataform_v1beta1 { * // Do the magic * const res = * await dataform.projects.locations.repositories.releaseConfigs.delete({ - * // Required. The release config's name. + * // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest) * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', * }); * console.log(res.data); @@ -8900,7 +8900,7 @@ export namespace dataform_v1beta1 { * // Do the magic * const res = await dataform.projects.locations.repositories.releaseConfigs.get( * { - * // Required. The release config's name. + * // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest) * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', * }, * ); @@ -9050,7 +9050,7 @@ export namespace dataform_v1beta1 { * await dataform.projects.locations.repositories.releaseConfigs.list({ * // Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest) * pageToken: 'placeholder-value', * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. * parent: @@ -9338,7 +9338,7 @@ export namespace dataform_v1beta1 { */ parent?: string; /** - * Required. The ID to use for the release config, which will become the final component of the release config's resource name. + * Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) */ releaseConfigId?: string; @@ -9349,13 +9349,13 @@ export namespace dataform_v1beta1 { } export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete extends StandardParameters { /** - * Required. The release config's name. + * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest) */ name?: string; } export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get extends StandardParameters { /** - * Required. The release config's name. + * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest) */ name?: string; } @@ -9365,7 +9365,7 @@ export namespace dataform_v1beta1 { */ pageSize?: number; /** - * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest) */ pageToken?: string; /** diff --git a/src/apis/datamanager/v1.ts b/src/apis/datamanager/v1.ts index eb13804d0ef..d249368eeee 100644 --- a/src/apis/datamanager/v1.ts +++ b/src/apis/datamanager/v1.ts @@ -167,6 +167,10 @@ export namespace datamanager_v1 { * Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad. */ landingPageDeviceInfo?: Schema$DeviceInfo; + /** + * Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers. + */ + mobileDeviceId?: string | null; /** * Optional. Session attributes for event attribution and modeling. */ @@ -247,6 +251,10 @@ export namespace datamanager_v1 { * The cart data associated with the event. */ export interface Schema$CartData { + /** + * Optional. The list of coupon codes that were applied to the cart. Cart-level and item-level coupon codes are independent. If the event is for a Google Analytics destination, only provide a single coupon code. Google Analytics ignores additional coupon codes. + */ + couponCodes?: string[] | null; /** * Optional. The list of items associated with the event. */ @@ -340,10 +348,50 @@ export namespace datamanager_v1 { * Information about the device being used (if any) when the event happened. */ export interface Schema$DeviceInfo { + /** + * Optional. The brand of the device. + */ + brand?: string | null; + /** + * Optional. The brand or type of the browser. + */ + browser?: string | null; + /** + * Optional. The version of the browser. + */ + browserVersion?: string | null; + /** + * Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”. + */ + category?: string | null; /** * Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. */ ipAddress?: string | null; + /** + * Optional. The language the device uses in ISO 639-1 format. + */ + languageCode?: string | null; + /** + * Optional. The model of the device. + */ + model?: string | null; + /** + * Optional. The operating system or platform of the device. + */ + operatingSystem?: string | null; + /** + * Optional. The version of the operating system or platform. + */ + operatingSystemVersion?: string | null; + /** + * Optional. The height of the screen in pixels. + */ + screenHeight?: number | null; + /** + * Optional. The width of the screen in pixels. + */ + screenWidth?: number | null; /** * Optional. The user-agent string of the device for the given context. */ @@ -400,6 +448,10 @@ export namespace datamanager_v1 { * Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks). */ adIdentifiers?: Schema$AdIdentifiers; + /** + * Optional. A unique identifier for the user instance of an app client for this GA4 app stream. + */ + appInstanceId?: string | null; /** * Optional. Information about the transaction and items associated with the event. */ @@ -432,6 +484,10 @@ export namespace datamanager_v1 { * Optional. Information gathered about the device being used (if any) when the event happened. */ eventDeviceInfo?: Schema$DeviceInfo; + /** + * Optional. Information gathered about the location of the user when this event occurred. + */ + eventLocation?: Schema$EventLocation; /** * Optional. The name of the event. Required for GA4 events. */ @@ -453,7 +509,11 @@ export namespace datamanager_v1 { */ lastUpdatedTimestamp?: string | null; /** - * Optional. The unique identifier for this event. Required for conversions using multiple data sources. + * Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data. + */ + thirdPartyUserData?: Schema$UserData; + /** + * Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions. */ transactionId?: string | null; /** @@ -469,6 +529,35 @@ export namespace datamanager_v1 { */ userProperties?: Schema$UserProperties; } + /** + * The location where the event occurred. + */ + export interface Schema$EventLocation { + /** + * Optional. The name of the city where the event occurred. + */ + city?: string | null; + /** + * Optional. The continent code in UN M49 format where the event occurred. + */ + continentCode?: string | null; + /** + * Optional. The 2-letter CLDR region code of the user's address. + */ + regionCode?: string | null; + /** + * Optional. Required for Store Sales. The identifier to represent a physical store where the event happened. + */ + storeId?: string | null; + /** + * Optional. The subcontinent code in UN M49 format where the event occurred. + */ + subcontinentCode?: string | null; + /** + * Optional. The ISO 3166-2 subdivision code where the event occurred. + */ + subdivisionCode?: string | null; + } /** * Event parameter for GA4 events. */ @@ -740,10 +829,30 @@ export namespace datamanager_v1 { * Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields. */ additionalItemParameters?: Schema$ItemParameter[]; + /** + * Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item. + */ + conversionValue?: number | null; + /** + * Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions. + */ + customVariables?: Schema$ItemCustomVariable[]; /** * Optional. A unique identifier to reference the item. */ itemId?: string | null; + /** + * Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events. + */ + merchantFeedLabel?: string | null; + /** + * Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded. + */ + merchantFeedLanguageCode?: string | null; + /** + * Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events. + */ + merchantId?: string | null; /** * Optional. The product ID within the Merchant Center account. */ @@ -757,6 +866,23 @@ export namespace datamanager_v1 { */ unitPrice?: number | null; } + /** + * Item-level custom variable for ads conversions. + */ + export interface Schema$ItemCustomVariable { + /** + * Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used. + */ + destinationReferences?: string[] | null; + /** + * Optional. The value to store for the custom variable. + */ + value?: string | null; + /** + * Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored. + */ + variable?: string | null; + } /** * A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields. */ @@ -1139,7 +1265,7 @@ export namespace datamanager_v1 { */ destination?: Schema$Destination; /** - * An error info error containing the error reason and error counts related to the upload. + * An error info error containing the error reason and error counts related to the upload. Only populated if the `request_status` is `FAILED` or `PARTIAL_SUCCESS`. This field isn't populated while the request has `request_status` of `PROCESSING`. */ errorInfo?: Schema$ErrorInfo; /** @@ -1151,7 +1277,7 @@ export namespace datamanager_v1 { */ requestStatus?: string | null; /** - * A warning info containing the warning reason and warning counts related to the upload. + * A warning info containing the warning reason and warning counts related to the upload. This field isn't populated while the request has `request_status` of `PROCESSING`. */ warningInfo?: Schema$WarningInfo; } @@ -1207,10 +1333,18 @@ export namespace datamanager_v1 { * Output only. Estimated number of members in this user list, on the Google Display Network. */ displayNetworkMembersCount?: string | null; + /** + * Output only. Estimated number of members in this user list on Gmail. + */ + gmailMembersCount?: string | null; /** * Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. */ searchNetworkMembersCount?: string | null; + /** + * Output only. Estimated number of members in this user list on YouTube. + */ + youtubeMembersCount?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index a5a14910b95..316044e1a25 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -4037,6 +4037,10 @@ export namespace dataplex_v1 { * Lookup Context using permissions in the source system. */ export interface Schema$GoogleCloudDataplexV1LookupContextRequest { + /** + * Optional. The text representing contextual information for which metadata context is being requested. + */ + context?: string | null; /** * Optional. Allows to configure the context.Supported options: format - The format of the context (one of yaml, xml, json, default is yaml). context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount. */ @@ -7828,6 +7832,7 @@ export namespace dataplex_v1 { * requestBody: { * // request body parameters * // { + * // "context": "my_context", * // "options": {}, * // "resources": [] * // } @@ -14844,7 +14849,7 @@ export namespace dataplex_v1 { * * // Do the magic * const res = await dataplex.projects.locations.dataScans.create({ - * // Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. + * // Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix "data-scan-". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. * dataScanId: 'placeholder-value', * // Required. The resource name of the parent location: projects/{project\}/locations/{location_id\} where project refers to a project_id or project_number and location_id refers to a Google Cloud region. * parent: 'projects/my-project/locations/my-location', @@ -16419,7 +16424,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Datascans$Create extends StandardParameters { /** - * Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. + * Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix "data-scan-". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. */ dataScanId?: string; /** diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index e61c05dce3a..0004a905bbc 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -718,7 +718,7 @@ export namespace dataproc_v1 { */ clusterType?: string | null; /** - * Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. + * Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Dataproc determines a Cloud Storage location (US, ASIA, or EU) for the cluster staging bucket according to the Compute Engine zone where the cluster is deployed, and then creates and manages this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. */ configBucket?: string | null; /** @@ -778,7 +778,7 @@ export namespace dataproc_v1 { */ softwareConfig?: Schema$SoftwareConfig; /** - * Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. + * Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc determines a Cloud Storage location (US, ASIA, or EU) for the cluster temp bucket according to the Compute Engine zone where the cluster is deployed, and then creates and manages this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. */ tempBucket?: string | null; /** @@ -939,7 +939,7 @@ export namespace dataproc_v1 { */ export interface Schema$ConfidentialInstanceConfig { /** - * Optional. Defines whether the instance should have confidential compute enabled. + * Optional. Deprecated: Use 'confidential_instance_type' instead. Defines whether the instance should have confidential compute enabled. */ enableConfidentialCompute?: boolean | null; } @@ -1037,11 +1037,11 @@ export namespace dataproc_v1 { */ bootDiskSizeGb?: number | null; /** - * Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types). + * Optional. Type of the boot disk (default is pd-standard). Valid values: pd-balanced (Persistent Disk Balanced Solid State Drive), pd-ssd (Persistent Disk Solid State Drive), or pd-standard (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types). */ bootDiskType?: string | null; /** - * Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance). + * Optional. Interface type of local SSDs (default is scsi). Valid values: scsi (Small Computer System Interface), nvme (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance). */ localSsdInterface?: string | null; /** @@ -1330,7 +1330,7 @@ export namespace dataproc_v1 { */ metadata?: {[key: string]: string} | null; /** - * Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default + * Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default */ networkUri?: string | null; /** @@ -4694,7 +4694,7 @@ export namespace dataproc_v1 { */ kubernetesClusterConfig?: Schema$KubernetesClusterConfig; /** - * Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. + * Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Dataproc determines a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. */ stagingBucket?: string | null; } @@ -20609,7 +20609,7 @@ export namespace dataproc_v1 { * * // Do the magic * const res = await dataproc.projects.regions.clusters.list({ - * // Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * + * // Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be "*" to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * * filter: 'placeholder-value', * // Optional. The maximum number of clusters to return in each response. The service may return fewer than this value. If unspecified, the default value is 200. The maximum value is 1000. * pageSize: 'placeholder-value', @@ -21789,7 +21789,7 @@ export namespace dataproc_v1 { } export interface Params$Resource$Projects$Regions$Clusters$List extends StandardParameters { /** - * Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * + * Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be "*" to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * */ filter?: string; /** diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index ab1652052dd..7dae2b15302 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -3182,6 +3182,10 @@ export namespace dfareporting_v4 { * Contains dependent field value information. */ export interface Schema$DependentFieldValue { + /** + * Optional. The ID of the dynamic feed that value's field will match against. + */ + dynamicFeedId?: string | null; /** * Optional. The ID of the element that value's field will match against. */ diff --git a/src/apis/dfareporting/v5.ts b/src/apis/dfareporting/v5.ts index 363ba5bd7f0..ec7cc89892a 100644 --- a/src/apis/dfareporting/v5.ts +++ b/src/apis/dfareporting/v5.ts @@ -3122,6 +3122,10 @@ export namespace dfareporting_v5 { * Contains dependent field value information. */ export interface Schema$DependentFieldValue { + /** + * Optional. The ID of the dynamic feed that value's field will match against. + */ + dynamicFeedId?: string | null; /** * Optional. The ID of the element that value's field will match against. */ diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 763a4fe1091..07c2facb343 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -2104,6 +2104,8 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2CesAppSpec { cesApp?: string | null; confirmationRequirement?: string | null; + proactiveEnabled?: boolean | null; + reactiveEnabled?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2CesToolSpec { cesTool?: string | null; diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 6a39bf01e0d..23139c5aa19 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -1480,6 +1480,8 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2beta1CesAppSpec { cesApp?: string | null; confirmationRequirement?: string | null; + proactiveEnabled?: boolean | null; + reactiveEnabled?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2beta1CesToolSpec { cesTool?: string | null; diff --git a/src/apis/firebaseappdistribution/v1.ts b/src/apis/firebaseappdistribution/v1.ts index 714b1ab095a..28be754874a 100644 --- a/src/apis/firebaseappdistribution/v1.ts +++ b/src/apis/firebaseappdistribution/v1.ts @@ -447,6 +447,10 @@ export namespace firebaseappdistribution_v1 { * Scotty-provided SHA256 hash for an upload. */ sha256Hash?: string | null; + /** + * Scotty-provided SHA512 hash for an upload. + */ + sha512Hash?: string | null; /** * Time at which the media data was last updated, in milliseconds since UNIX epoch */ diff --git a/src/apis/firebasedataconnect/v1.ts b/src/apis/firebasedataconnect/v1.ts index 78ef345a011..04bd3001915 100644 --- a/src/apis/firebasedataconnect/v1.ts +++ b/src/apis/firebasedataconnect/v1.ts @@ -150,6 +150,19 @@ export namespace firebasedataconnect_v1 { */ instance?: string | null; } + /** + * A chunk of code. + */ + export interface Schema$CodeChunk { + /** + * Required. The code content string. + */ + code?: string | null; + /** + * Optional. Specifies the language if we expand support beyond GraphQL (e.g., SQL or JSON) The standard is BCP-47 language code. + */ + languageCode?: string | null; + } /** * Connector consists of a set of operations, i.e. queries and mutations. */ @@ -310,6 +323,67 @@ export namespace firebasedataconnect_v1 { */ path?: string | null; } + /** + * Request message for GenerateQuery. + */ + export interface Schema$GenerateQueryRequest { + /** + * Required. The natural language description of the desired query. Example: "Find all users who signed up in the last 7 days." + */ + prompt?: string | null; + /** + * Optional. The user's locally defined FDC Schema(s). If not defined, the backend will fetch the user's deployed schema. + */ + schemas?: Schema$Schema[]; + } + /** + * Output for streaming generate query requests + */ + export interface Schema$GenerateQueryResponse { + /** + * Required. The content from the current conversational turn. + */ + part?: Schema$Part; + /** + * Essential for providing responsive UI feedback (e.g., a spinner or "Analyzing schema..." step). + */ + status?: Schema$GenerationStatus; + } + /** + * Request message for GenerateSchema. + */ + export interface Schema$GenerateSchemaRequest { + /** + * Required. The natural language description of the data model to generate. Example: "A blog system with Users, Posts, and Comments. Users can have multiple posts." + */ + prompt?: string | null; + } + /** + * Output for streaming generate schema requests + */ + export interface Schema$GenerateSchemaResponse { + /** + * The content from the current conversational turn. + */ + part?: Schema$Part; + /** + * Essential for providing responsive UI feedback (e.g., a spinner or "Analyzing schema..." step). + */ + status?: Schema$GenerationStatus; + } + /** + * Represents the progress of the server side generation request. + */ + export interface Schema$GenerationStatus { + /** + * Output only. A message providing more details about the state. + */ + message?: string | null; + /** + * Output only. The state of generation. + */ + state?: string | null; + } /** * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase SQL Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. */ @@ -623,6 +697,19 @@ export namespace firebasedataconnect_v1 { */ verb?: string | null; } + /** + * Represents a chunk of content. + */ + export interface Schema$Part { + /** + * Optional. A chunk of code. + */ + codeChunk?: Schema$CodeChunk; + /** + * Optional. A chunk of text. + */ + textChunk?: Schema$TextChunk; + } /** * Settings for PostgreSQL data source. */ @@ -644,11 +731,11 @@ export namespace firebasedataconnect_v1 { */ schema?: string | null; /** - * Optional. Configure how to perform Postgresql schema migration. + * Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. */ schemaMigration?: string | null; /** - * Optional. Configure how much Postgresql schema validation to perform. + * Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. */ schemaValidation?: string | null; /** @@ -785,6 +872,15 @@ export namespace firebasedataconnect_v1 { */ message?: string | null; } + /** + * A chunk of conversational text. + */ + export interface Schema$TextChunk { + /** + * Required. The text content string. + */ + text?: string | null; + } /** * Workaround provides suggestions to address errors and warnings. */ @@ -2393,6 +2489,313 @@ export namespace firebasedataconnect_v1 { } } + /** + * Generates a GraphQL query based on a natural language prompt and the provided schema context. This is a stateless method; the schema is provided per request to support local development states. Streams results with real-time status and output chunks. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firebasedataconnect.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firebasedataconnect = google.firebasedataconnect('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await firebasedataconnect.projects.locations.services.generateQuery({ + * // Required. The resource name of the service in which to generate the query. Format: projects/{project\}/locations/{location\}/services/{service\} + * name: 'projects/my-project/locations/my-location/services/my-service', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "prompt": "my_prompt", + * // "schemas": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "part": {}, + * // "status": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + options: StreamMethodOptions + ): Promise>; + generateQuery( + params?: Params$Resource$Projects$Locations$Services$Generatequery, + options?: MethodOptions + ): Promise>; + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + callback: BodyResponseCallback + ): void; + generateQuery( + callback: BodyResponseCallback + ): void; + generateQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Generatequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Generatequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Generatequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates GraphQL schema based on a natural language prompt or data description. This allows users to scaffold new types and tables quickly. Streams results with real-time status and output chunks. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firebasedataconnect.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firebasedataconnect = google.firebasedataconnect('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await firebasedataconnect.projects.locations.services.generateSchema({ + * // Required. The resource name of the service in which to generate the schema. Format: projects/{project\}/locations/{location\}/services/{service\} + * name: 'projects/my-project/locations/my-location/services/my-service', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "prompt": "my_prompt" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "part": {}, + * // "status": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + options: StreamMethodOptions + ): Promise>; + generateSchema( + params?: Params$Resource$Projects$Locations$Services$Generateschema, + options?: MethodOptions + ): Promise>; + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + callback: BodyResponseCallback + ): void; + generateSchema( + callback: BodyResponseCallback + ): void; + generateSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Generateschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Generateschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Generateschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateSchema').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets details of a single Service. * @example @@ -3076,6 +3479,28 @@ export namespace firebasedataconnect_v1 { */ requestBody?: Schema$GraphqlRequest; } + export interface Params$Resource$Projects$Locations$Services$Generatequery extends StandardParameters { + /** + * Required. The resource name of the service in which to generate the query. Format: projects/{project\}/locations/{location\}/services/{service\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateQueryRequest; + } + export interface Params$Resource$Projects$Locations$Services$Generateschema extends StandardParameters { + /** + * Required. The resource name of the service in which to generate the schema. Format: projects/{project\}/locations/{location\}/services/{service\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateSchemaRequest; + } export interface Params$Resource$Projects$Locations$Services$Get extends StandardParameters { /** * Required. The name of the service to retrieve, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` diff --git a/src/apis/firebasedataconnect/v1beta.ts b/src/apis/firebasedataconnect/v1beta.ts index 8a58b14495a..78d7591f604 100644 --- a/src/apis/firebasedataconnect/v1beta.ts +++ b/src/apis/firebasedataconnect/v1beta.ts @@ -150,6 +150,19 @@ export namespace firebasedataconnect_v1beta { */ instance?: string | null; } + /** + * A chunk of code. + */ + export interface Schema$CodeChunk { + /** + * Required. The code content string. + */ + code?: string | null; + /** + * Optional. Specifies the language if we expand support beyond GraphQL (e.g., SQL or JSON) The standard is BCP-47 language code. + */ + languageCode?: string | null; + } /** * Connector consists of a set of operations, i.e. queries and mutations. */ @@ -310,6 +323,67 @@ export namespace firebasedataconnect_v1beta { */ path?: string | null; } + /** + * Request message for GenerateQuery. + */ + export interface Schema$GenerateQueryRequest { + /** + * Required. The natural language description of the desired query. Example: "Find all users who signed up in the last 7 days." + */ + prompt?: string | null; + /** + * Optional. The user's locally defined FDC Schema(s). If not defined, the backend will fetch the user's deployed schema. + */ + schemas?: Schema$Schema[]; + } + /** + * Output for streaming generate query requests + */ + export interface Schema$GenerateQueryResponse { + /** + * Required. The content from the current conversational turn. + */ + part?: Schema$Part; + /** + * Essential for providing responsive UI feedback (e.g., a spinner or "Analyzing schema..." step). + */ + status?: Schema$GenerationStatus; + } + /** + * Request message for GenerateSchema. + */ + export interface Schema$GenerateSchemaRequest { + /** + * Required. The natural language description of the data model to generate. Example: "A blog system with Users, Posts, and Comments. Users can have multiple posts." + */ + prompt?: string | null; + } + /** + * Output for streaming generate schema requests + */ + export interface Schema$GenerateSchemaResponse { + /** + * The content from the current conversational turn. + */ + part?: Schema$Part; + /** + * Essential for providing responsive UI feedback (e.g., a spinner or "Analyzing schema..." step). + */ + status?: Schema$GenerationStatus; + } + /** + * Represents the progress of the server side generation request. + */ + export interface Schema$GenerationStatus { + /** + * Output only. A message providing more details about the state. + */ + message?: string | null; + /** + * Output only. The state of generation. + */ + state?: string | null; + } /** * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase SQL Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. */ @@ -623,6 +697,19 @@ export namespace firebasedataconnect_v1beta { */ verb?: string | null; } + /** + * Represents a chunk of content. + */ + export interface Schema$Part { + /** + * Optional. A chunk of code. + */ + codeChunk?: Schema$CodeChunk; + /** + * Optional. A chunk of text. + */ + textChunk?: Schema$TextChunk; + } /** * Settings for PostgreSQL data source. */ @@ -644,11 +731,11 @@ export namespace firebasedataconnect_v1beta { */ schema?: string | null; /** - * Optional. Configure how to perform Postgresql schema migration. + * Optional. Configure how to perform automatic PostgreSQL schema migration before deploying the FDC schema. This is an additive-only operation. */ schemaMigration?: string | null; /** - * Optional. Configure how much Postgresql schema validation to perform. + * Optional. Configure how much PostgreSQL schema validation to perform against the live database before deploying the FDC schema. */ schemaValidation?: string | null; /** @@ -785,6 +872,15 @@ export namespace firebasedataconnect_v1beta { */ message?: string | null; } + /** + * A chunk of conversational text. + */ + export interface Schema$TextChunk { + /** + * Required. The text content string. + */ + text?: string | null; + } /** * Workaround provides suggestions to address errors and warnings. */ @@ -2396,6 +2492,313 @@ export namespace firebasedataconnect_v1beta { } } + /** + * Generates a GraphQL query based on a natural language prompt and the provided schema context. This is a stateless method; the schema is provided per request to support local development states. Streams results with real-time status and output chunks. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firebasedataconnect.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firebasedataconnect = google.firebasedataconnect('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await firebasedataconnect.projects.locations.services.generateQuery({ + * // Required. The resource name of the service in which to generate the query. Format: projects/{project\}/locations/{location\}/services/{service\} + * name: 'projects/my-project/locations/my-location/services/my-service', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "prompt": "my_prompt", + * // "schemas": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "part": {}, + * // "status": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + options: StreamMethodOptions + ): Promise>; + generateQuery( + params?: Params$Resource$Projects$Locations$Services$Generatequery, + options?: MethodOptions + ): Promise>; + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateQuery( + params: Params$Resource$Projects$Locations$Services$Generatequery, + callback: BodyResponseCallback + ): void; + generateQuery( + callback: BodyResponseCallback + ): void; + generateQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Generatequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Generatequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Generatequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:generateQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates GraphQL schema based on a natural language prompt or data description. This allows users to scaffold new types and tables quickly. Streams results with real-time status and output chunks. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firebasedataconnect.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firebasedataconnect = google.firebasedataconnect('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await firebasedataconnect.projects.locations.services.generateSchema({ + * // Required. The resource name of the service in which to generate the schema. Format: projects/{project\}/locations/{location\}/services/{service\} + * name: 'projects/my-project/locations/my-location/services/my-service', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "prompt": "my_prompt" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "part": {}, + * // "status": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + options: StreamMethodOptions + ): Promise>; + generateSchema( + params?: Params$Resource$Projects$Locations$Services$Generateschema, + options?: MethodOptions + ): Promise>; + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSchema( + params: Params$Resource$Projects$Locations$Services$Generateschema, + callback: BodyResponseCallback + ): void; + generateSchema( + callback: BodyResponseCallback + ): void; + generateSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Generateschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Generateschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Services$Generateschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:generateSchema').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets details of a single Service. * @example @@ -3079,6 +3482,28 @@ export namespace firebasedataconnect_v1beta { */ requestBody?: Schema$GraphqlRequest; } + export interface Params$Resource$Projects$Locations$Services$Generatequery extends StandardParameters { + /** + * Required. The resource name of the service in which to generate the query. Format: projects/{project\}/locations/{location\}/services/{service\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateQueryRequest; + } + export interface Params$Resource$Projects$Locations$Services$Generateschema extends StandardParameters { + /** + * Required. The resource name of the service in which to generate the schema. Format: projects/{project\}/locations/{location\}/services/{service\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateSchemaRequest; + } export interface Params$Resource$Projects$Locations$Services$Get extends StandardParameters { /** * Required. The name of the service to retrieve, in the format: ``` projects/{project\}/locations/{location\}/services/{service\} ``` diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index 3a0eee6f0c8..e63e50dd19c 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -581,6 +581,10 @@ export namespace firebaseml_v2beta { * Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. */ export interface Schema$GoogleCloudAiplatformV1beta1FunctionDeclaration { + /** + * Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + */ + behavior?: string | null; /** * Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */ diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 0391293870b..9c556dfc586 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -3231,7 +3231,7 @@ export namespace gkehub_v1alpha { targets?: Schema$RolloutTarget[]; } /** - * RolloutSequence defines the desired order of upgrades. + * RolloutSequence defines the desired order of upgrades. Next ID: 20 */ export interface Schema$RolloutSequence { /** diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index d67f04ecfc5..aa7f73c0b6d 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -3075,7 +3075,7 @@ export namespace gkehub_v1beta { targets?: Schema$RolloutTarget[]; } /** - * RolloutSequence defines the desired order of upgrades. + * RolloutSequence defines the desired order of upgrades. Next ID: 20 */ export interface Schema$RolloutSequence { /** diff --git a/src/apis/hypercomputecluster/v1.ts b/src/apis/hypercomputecluster/v1.ts index 62376906f71..bba0b515b84 100644 --- a/src/apis/hypercomputecluster/v1.ts +++ b/src/apis/hypercomputecluster/v1.ts @@ -129,7 +129,7 @@ export namespace hypercomputecluster_v1 { */ export interface Schema$BootDisk { /** - * Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB. + * Required. Immutable. Size of the disk in gigabytes. Must be at least 40GB. */ sizeGb?: string | null; /** diff --git a/src/apis/index.ts b/src/apis/index.ts index e36352b62b2..4d41d085159 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -229,6 +229,10 @@ import { VERSIONS as cloudlocationfinderVersions, cloudlocationfinder, } from './cloudlocationfinder'; +import { + VERSIONS as cloudnumberregistryVersions, + cloudnumberregistry, +} from './cloudnumberregistry'; import { VERSIONS as cloudprofilerVersions, cloudprofiler, @@ -878,6 +882,7 @@ export const APIS: APIList = { cloudiot: cloudiotVersions, cloudkms: cloudkmsVersions, cloudlocationfinder: cloudlocationfinderVersions, + cloudnumberregistry: cloudnumberregistryVersions, cloudprofiler: cloudprofilerVersions, cloudresourcemanager: cloudresourcemanagerVersions, cloudscheduler: cloudschedulerVersions, @@ -1205,6 +1210,7 @@ export class GeneratedAPIs { cloudiot = cloudiot; cloudkms = cloudkms; cloudlocationfinder = cloudlocationfinder; + cloudnumberregistry = cloudnumberregistry; cloudprofiler = cloudprofiler; cloudresourcemanager = cloudresourcemanager; cloudscheduler = cloudscheduler; diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 6e10d00e560..7c9bfec5131 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -502,7 +502,7 @@ export namespace logging_v2 { title?: string | null; } /** - * A source that can be used to represent a field within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. + * A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. */ export interface Schema$FieldSource { /** @@ -1656,7 +1656,7 @@ export namespace logging_v2 { version?: number | null; } /** - * Represents a field selected in the query, analogous to an item in a SQL SELECT clause. It specifies the source field and optionally applies transformations like aggregation, casting, regex extraction, or assigns an alias. Use ProjectedField when you need more than just the raw source field name (for which you might use FieldSource directly in QueryBuilderConfig's field_sources list if no transformations or specific operation type are needed). + * Represents a field selected in the query, analogous to an item in a SQL SELECT clause. It specifies the source field and optionally applies transformations like aggregation, casting, regex extraction, or assigns an alias. Use ProjectedField when you need more than just the raw source field name (for which you might use FieldSource directly in QueryBuilderConfig's field_sources list if no transformations or specific operation type are needed).A ProjectedField can represent either a field present in the data schema (specified via the field property) or a virtual field that is computed from other fields (specified via the virtual_field property). */ export interface Schema$ProjectedField { /** @@ -1668,7 +1668,7 @@ export namespace logging_v2 { */ cast?: string | null; /** - * The field name. This will be the field that is selected using the dot notation to display the drill down value. + * Optional. The field name. This will be the field that is selected using the dot notation to display the drill down value. */ field?: string | null; /** @@ -3472,7 +3472,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.billingAccounts.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3598,7 +3598,7 @@ export namespace logging_v2 { } export interface Params$Resource$Billingaccounts$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -12414,7 +12414,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.folders.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -12540,7 +12540,7 @@ export namespace logging_v2 { } export interface Params$Resource$Folders$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -19891,7 +19891,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -20016,7 +20016,7 @@ export namespace logging_v2 { } export interface Params$Resource$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -25966,7 +25966,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.organizations.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -26092,7 +26092,7 @@ export namespace logging_v2 { } export interface Params$Resource$Organizations$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -34608,7 +34608,7 @@ export namespace logging_v2 { * * // Do the magic * const res = await logging.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -34734,7 +34734,7 @@ export namespace logging_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index ba3a212485e..0289767a1e9 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -981,7 +981,7 @@ export namespace looker_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -1011,7 +1011,7 @@ export namespace looker_v1 { * * // Do the magic * const res = await looker.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1137,7 +1137,7 @@ export namespace looker_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/managedidentities/v1.ts b/src/apis/managedidentities/v1.ts index a0d97ebd7a6..2b49b2f19e2 100644 --- a/src/apis/managedidentities/v1.ts +++ b/src/apis/managedidentities/v1.ts @@ -1469,7 +1469,7 @@ export namespace managedidentities_v1 { * * // Do the magic * const res = await managedidentities.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1596,7 +1596,7 @@ export namespace managedidentities_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/managedidentities/v1alpha1.ts b/src/apis/managedidentities/v1alpha1.ts index 7aade4f047b..91395c68fc0 100644 --- a/src/apis/managedidentities/v1alpha1.ts +++ b/src/apis/managedidentities/v1alpha1.ts @@ -1452,7 +1452,7 @@ export namespace managedidentities_v1alpha1 { * * // Do the magic * const res = await managedidentities.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1579,7 +1579,7 @@ export namespace managedidentities_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/managedidentities/v1beta1.ts b/src/apis/managedidentities/v1beta1.ts index 6b371f8044b..d3bcf387baa 100644 --- a/src/apis/managedidentities/v1beta1.ts +++ b/src/apis/managedidentities/v1beta1.ts @@ -1477,7 +1477,7 @@ export namespace managedidentities_v1beta1 { * * // Do the magic * const res = await managedidentities.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1604,7 +1604,7 @@ export namespace managedidentities_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/merchantapi/products_v1.ts b/src/apis/merchantapi/products_v1.ts index 8558da8a921..ef3d5e7ee20 100644 --- a/src/apis/merchantapi/products_v1.ts +++ b/src/apis/merchantapi/products_v1.ts @@ -480,6 +480,19 @@ export namespace merchantapi_products_v1 { */ value?: string | null; } + /** + * The pickup cost of the item. + */ + export interface Schema$PickupCost { + /** + * Required. The flat rate pickup cost of the item. + */ + flatRate?: Schema$Price; + /** + * Optional. The price threshold above which pickup is free of charge. + */ + freeThreshold?: Schema$Price; + } /** * The price represented as a number and currency. */ @@ -846,6 +859,10 @@ export namespace merchantapi_products_v1 { * Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). */ pause?: string | null; + /** + * Optional. The [pickup cost](https://support.google.com/merchants/answer/16988704) for an item when a customer buys it online and picks it up at a store. + */ + pickupCost?: Schema$PickupCost; /** * The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. */ diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index e7c26d5b446..926a0257ada 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -132,6 +132,10 @@ export namespace ondemandscanning_v1 { * Findings produced by the analysis. */ findings?: Schema$Finding[]; + /** + * Maximum severity found among findings. + */ + maxSeverity?: string | null; /** * Name of the skill that produced this analysis. */ @@ -662,29 +666,30 @@ export namespace ondemandscanning_v1 { */ category?: string | null; /** - * Detailed description of the finding. - */ - description?: string | null; - /** - * Path to the file where the finding was detected. + * Location (path and line) where the finding was detected. */ - filePath?: string | null; + location?: Schema$FindingLocation; /** - * Unique identifier of the rule that produced this finding. + * Scanner determines which engine (e.g. static, llm) emitted the finding. */ - ruleId?: string | null; + scanner?: string | null; /** * Severity of the finding. */ severity?: string | null; + } + /** + * Location details with file path and line number. + */ + export interface Schema$FindingLocation { /** - * Code snippet relevant to the finding. + * Relative path of the file containing the finding. */ - snippet?: string | null; + filePath?: string | null; /** - * Title of the finding. + * Line number (1-based), or 0 if whole File / unknown. */ - title?: string | null; + lineNumber?: string | null; } /** * A set of properties that uniquely identify a given Docker image. diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index f2d1a117f9d..ce7a7d37890 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -132,6 +132,10 @@ export namespace ondemandscanning_v1beta1 { * Findings produced by the analysis. */ findings?: Schema$Finding[]; + /** + * Maximum severity found among findings. + */ + maxSeverity?: string | null; /** * Name of the skill that produced this analysis. */ @@ -658,29 +662,30 @@ export namespace ondemandscanning_v1beta1 { */ category?: string | null; /** - * Detailed description of the finding. - */ - description?: string | null; - /** - * Path to the file where the finding was detected. + * Location (path and line) where the finding was detected. */ - filePath?: string | null; + location?: Schema$FindingLocation; /** - * Unique identifier of the rule that produced this finding. + * Scanner determines which engine (e.g. static, llm) emitted the finding. */ - ruleId?: string | null; + scanner?: string | null; /** * Severity of the finding. */ severity?: string | null; + } + /** + * Location details with file path and line number. + */ + export interface Schema$FindingLocation { /** - * Code snippet relevant to the finding. + * Relative path of the file containing the finding. */ - snippet?: string | null; + filePath?: string | null; /** - * Title of the finding. + * Line number (1-based), or 0 if whole File / unknown. */ - title?: string | null; + lineNumber?: string | null; } /** * A set of properties that uniquely identify a given Docker image. diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index 5b7e5a7bdad..e338309a3f9 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -327,6 +327,10 @@ export namespace privateca_v1 { * Immutable. A pem-encoded X.509 certificate signing request (CSR). */ pemCsr?: string | null; + /** + * Optional. The requested not_before_time of this Certificate. This field may only be set if the CaPool.IssuancePolicy.allow_requester_specified_not_before_time field is set to true for the issuing CaPool. If this field is specified, the certificate will be issued with this 'not_before_time'. If this is not specified, the 'not_before_time' will be set to the issuance time or issuance time minus backdate_duration depending on the CaPool configuration. + */ + requestedNotBeforeTime?: string | null; /** * Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. */ @@ -767,6 +771,10 @@ export namespace privateca_v1 { * Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. */ allowedKeyTypes?: Schema$AllowedKeyType[]; + /** + * Optional. If set to true, allows requesters to specify the requested_not_before_time field when creating a Certificate. Certificates requested with this option enabled will have a 'not_before_time' equal to the value specified in the request. The 'not_after_time' will be adjusted to preserve the requested lifetime. The maximum time that a certificate can be backdated with these options is 48 hours in the past. This option cannot be set if backdate_duration is set. + */ + allowRequesterSpecifiedNotBeforeTime?: boolean | null; /** * Optional. If set, all certificates issued from this CaPool will be backdated by this duration. The 'not_before_time' will be the issuance time minus this backdate_duration, and the 'not_after_time' will be adjusted to preserve the requested lifetime. The maximum duration that a certificate can be backdated with these options is 48 hours in the past. This option cannot be set if allow_requester_specified_not_before_time is set. */ @@ -1642,7 +1650,7 @@ export namespace privateca_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -1672,7 +1680,7 @@ export namespace privateca_v1 { * * // Do the magic * const res = await privateca.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1798,7 +1806,7 @@ export namespace privateca_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -6079,6 +6087,7 @@ export namespace privateca_v1 { * // "pemCertificate": "my_pemCertificate", * // "pemCertificateChain": [], * // "pemCsr": "my_pemCsr", + * // "requestedNotBeforeTime": "my_requestedNotBeforeTime", * // "revocationDetails": {}, * // "subjectMode": "my_subjectMode", * // "updateTime": "my_updateTime" @@ -6100,6 +6109,7 @@ export namespace privateca_v1 { * // "pemCertificate": "my_pemCertificate", * // "pemCertificateChain": [], * // "pemCsr": "my_pemCsr", + * // "requestedNotBeforeTime": "my_requestedNotBeforeTime", * // "revocationDetails": {}, * // "subjectMode": "my_subjectMode", * // "updateTime": "my_updateTime" @@ -6251,6 +6261,7 @@ export namespace privateca_v1 { * // "pemCertificate": "my_pemCertificate", * // "pemCertificateChain": [], * // "pemCsr": "my_pemCsr", + * // "requestedNotBeforeTime": "my_requestedNotBeforeTime", * // "revocationDetails": {}, * // "subjectMode": "my_subjectMode", * // "updateTime": "my_updateTime" @@ -6553,6 +6564,7 @@ export namespace privateca_v1 { * // "pemCertificate": "my_pemCertificate", * // "pemCertificateChain": [], * // "pemCsr": "my_pemCsr", + * // "requestedNotBeforeTime": "my_requestedNotBeforeTime", * // "revocationDetails": {}, * // "subjectMode": "my_subjectMode", * // "updateTime": "my_updateTime" @@ -6574,6 +6586,7 @@ export namespace privateca_v1 { * // "pemCertificate": "my_pemCertificate", * // "pemCertificateChain": [], * // "pemCsr": "my_pemCsr", + * // "requestedNotBeforeTime": "my_requestedNotBeforeTime", * // "revocationDetails": {}, * // "subjectMode": "my_subjectMode", * // "updateTime": "my_updateTime" @@ -6731,6 +6744,7 @@ export namespace privateca_v1 { * // "pemCertificate": "my_pemCertificate", * // "pemCertificateChain": [], * // "pemCsr": "my_pemCsr", + * // "requestedNotBeforeTime": "my_requestedNotBeforeTime", * // "revocationDetails": {}, * // "subjectMode": "my_subjectMode", * // "updateTime": "my_updateTime" diff --git a/src/apis/privateca/v1beta1.ts b/src/apis/privateca/v1beta1.ts index 90d6c6642dc..0b5d1afa1db 100644 --- a/src/apis/privateca/v1beta1.ts +++ b/src/apis/privateca/v1beta1.ts @@ -511,7 +511,7 @@ export namespace privateca_v1beta1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -541,7 +541,7 @@ export namespace privateca_v1beta1 { * * // Do the magic * const res = await privateca.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -667,7 +667,7 @@ export namespace privateca_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/saasservicemgmt/v1.ts b/src/apis/saasservicemgmt/v1.ts index 2a5850ed950..43fdd393bcf 100644 --- a/src/apis/saasservicemgmt/v1.ts +++ b/src/apis/saasservicemgmt/v1.ts @@ -1387,7 +1387,7 @@ export namespace saasservicemgmt_v1 { * * // Do the magic * const res = await saasservicemgmt.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1514,7 +1514,7 @@ export namespace saasservicemgmt_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/saasservicemgmt/v1beta1.ts b/src/apis/saasservicemgmt/v1beta1.ts index 89fe095b272..8bd384e4bd5 100644 --- a/src/apis/saasservicemgmt/v1beta1.ts +++ b/src/apis/saasservicemgmt/v1beta1.ts @@ -273,6 +273,10 @@ export namespace saasservicemgmt_v1beta1 { * EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user. */ export interface Schema$EvaluationRule { + /** + * Optional. The ID of an allocation to target. + */ + allocationId?: string | null; /** * Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied. */ @@ -282,9 +286,13 @@ export namespace saasservicemgmt_v1beta1 { */ id?: string | null; /** - * Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID. + * Optional. Deprecated: Use `rule_target` instead. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID. */ target?: string | null; + /** + * Optional. The name of a variant to target. + */ + variantId?: string | null; } /** * EvaluationSpec holds rules for evaluating the value of a flag. @@ -299,9 +307,17 @@ export namespace saasservicemgmt_v1beta1 { */ attributes?: string[] | null; /** - * Required. Default variant or allocation of the flag. + * Optional. The ID of an allocation to use as the default. + */ + defaultAllocation?: string | null; + /** + * Optional. Deprecated: Use `base_target` instead. Default variant or allocation of the flag. */ defaultTarget?: string | null; + /** + * Optional. The name of a variant to use as the default. + */ + defaultVariant?: string | null; /** * Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order. */ @@ -1933,7 +1949,7 @@ export namespace saasservicemgmt_v1beta1 { * * // Do the magic * const res = await saasservicemgmt.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2060,7 +2076,7 @@ export namespace saasservicemgmt_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index d7e2da39e30..8dc7f92d04a 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -202,6 +202,10 @@ export namespace servicecontrol_v1 { * Common audit log format for Google Cloud Platform API operations. */ export interface Schema$AuditLog { + /** + * The API version identifier of the operation that uses interface based versioning (IBV). For example, `"2026-01-01-preview"`. The version identifier generally follows the format of [variant_]date[_decorator]. It should not be parsed because the exact format varies across services. + */ + apiVersionIdentifier?: string | null; /** * Authentication information. */ diff --git a/src/apis/solar/v1.ts b/src/apis/solar/v1.ts index f2371815beb..df2a383c8d0 100644 --- a/src/apis/solar/v1.ts +++ b/src/apis/solar/v1.ts @@ -144,6 +144,10 @@ export namespace solar_v1 { * A point near the center of the building. */ center?: Schema$LatLng; + /** + * Solar arrays detected on the building. This field is only populated if DETECTED_ARRAYS is included in the request's FindClosestBuildingInsightsRequest.additional_insights. + */ + detectedArrays?: Schema$BuildingInsightsDetectedArrays; /** * Date that the underlying imagery was acquired. This is approximate. */ @@ -177,6 +181,19 @@ export namespace solar_v1 { */ statisticalArea?: string | null; } + /** + * Information about solar arrays detected on the building. + */ + export interface Schema$BuildingInsightsDetectedArrays { + /** + * Indicates the detection status of solar arrays for this building. + */ + detectionStatus?: string | null; + /** + * The date indicating when the latest solar array data was captured. + */ + latestCaptureDate?: Schema$Date; + } /** * Cost and benefit of an outright purchase of a particular configuration of solar panels with a particular electricity usage. */ @@ -681,6 +698,8 @@ export namespace solar_v1 { * * // Do the magic * const res = await solar.buildingInsights.findClosest({ + * // Optional. A list of additional_insights to be included in the response. + * additionalInsights: 'placeholder-value', * // Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`. * exactQualityRequired: 'placeholder-value', * // Optional. Specifies the pre-GA experiments to enable. Requests using this field are classified as a pre-GA offering under the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). See [launch stage descriptions](https://cloud.google.com/maps-platform/terms/launch-stages) for more details. @@ -699,6 +718,7 @@ export namespace solar_v1 { * // "administrativeArea": "my_administrativeArea", * // "boundingBox": {}, * // "center": {}, + * // "detectedArrays": {}, * // "imageryDate": {}, * // "imageryProcessedDate": {}, * // "imageryQuality": "my_imageryQuality", @@ -807,6 +827,10 @@ export namespace solar_v1 { } export interface Params$Resource$Buildinginsights$Findclosest extends StandardParameters { + /** + * Optional. A list of additional_insights to be included in the response. + */ + additionalInsights?: string[]; /** * Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`. */ diff --git a/src/apis/vpcaccess/v1.ts b/src/apis/vpcaccess/v1.ts index 08a3595d41b..d07446fc7fb 100644 --- a/src/apis/vpcaccess/v1.ts +++ b/src/apis/vpcaccess/v1.ts @@ -384,7 +384,7 @@ export namespace vpcaccess_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -414,7 +414,7 @@ export namespace vpcaccess_v1 { * * // Do the magic * const res = await vpcaccess.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -534,7 +534,7 @@ export namespace vpcaccess_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/vpcaccess/v1beta1.ts b/src/apis/vpcaccess/v1beta1.ts index f2b3ac6115d..675bb13ebc7 100644 --- a/src/apis/vpcaccess/v1beta1.ts +++ b/src/apis/vpcaccess/v1beta1.ts @@ -392,7 +392,7 @@ export namespace vpcaccess_v1beta1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -422,7 +422,7 @@ export namespace vpcaccess_v1beta1 { * * // Do the magic * const res = await vpcaccess.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -542,7 +542,7 @@ export namespace vpcaccess_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index e9ee4eedfae..65c2e9ea5a5 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -2582,7 +2582,7 @@ export namespace workloadmanager_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -2612,7 +2612,7 @@ export namespace workloadmanager_v1 { * * // Do the magic * const res = await workloadmanager.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2739,7 +2739,7 @@ export namespace workloadmanager_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index c98044803bf..a37f576c216 100644 --- a/src/apis/workspaceevents/v1.ts +++ b/src/apis/workspaceevents/v1.ts @@ -184,6 +184,15 @@ export namespace workspaceevents_v1 { export interface Schema$DataPart { data?: {[key: string]: any} | null; } + /** + * Additional supported options for serving Drive events. + */ + export interface Schema$DriveOptions { + /** + * Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types). + */ + includeDescendants?: boolean | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -417,6 +426,10 @@ export namespace workspaceevents_v1 { * Output only. The time when the subscription is created. */ createTime?: string | null; + /** + * Optional. Features that are supported only for subscriptions on Drive resources. + */ + driveOptions?: Schema$DriveOptions; /** * Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding. */ @@ -988,6 +1001,7 @@ export namespace workspaceevents_v1 { * // { * // "authority": "my_authority", * // "createTime": "my_createTime", + * // "driveOptions": {}, * // "etag": "my_etag", * // "eventTypes": [], * // "expireTime": "my_expireTime", @@ -1334,6 +1348,7 @@ export namespace workspaceevents_v1 { * // { * // "authority": "my_authority", * // "createTime": "my_createTime", + * // "driveOptions": {}, * // "etag": "my_etag", * // "eventTypes": [], * // "expireTime": "my_expireTime", @@ -1675,6 +1690,7 @@ export namespace workspaceevents_v1 { * // { * // "authority": "my_authority", * // "createTime": "my_createTime", + * // "driveOptions": {}, * // "etag": "my_etag", * // "eventTypes": [], * // "expireTime": "my_expireTime", diff --git a/src/apis/youtubereporting/v1.ts b/src/apis/youtubereporting/v1.ts index 557d0b3205f..99b266417ad 100644 --- a/src/apis/youtubereporting/v1.ts +++ b/src/apis/youtubereporting/v1.ts @@ -453,6 +453,10 @@ export namespace youtubereporting_v1 { * gdata */ sha256Hash?: string | null; + /** + * gdata + */ + sha512Hash?: string | null; /** * gdata */ @@ -1672,6 +1676,7 @@ export namespace youtubereporting_v1 { * // "referenceType": "my_referenceType", * // "sha1Hash": "my_sha1Hash", * // "sha256Hash": "my_sha256Hash", + * // "sha512Hash": "my_sha512Hash", * // "timestamp": "my_timestamp", * // "token": "my_token" * // } diff --git a/src/index.ts b/src/index.ts index 3b486b9ce34..7ba8360d5aa 100644 --- a/src/index.ts +++ b/src/index.ts @@ -159,6 +159,7 @@ export {cloudiot_v1} from './apis/cloudiot/v1'; export {cloudkms_v1} from './apis/cloudkms/v1'; export {cloudlocationfinder_v1} from './apis/cloudlocationfinder/v1'; export {cloudlocationfinder_v1alpha} from './apis/cloudlocationfinder/v1alpha'; +export {cloudnumberregistry_v1alpha} from './apis/cloudnumberregistry/v1alpha'; export {cloudprofiler_v2} from './apis/cloudprofiler/v2'; export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; export {cloudresourcemanager_v1beta1} from './apis/cloudresourcemanager/v1beta1';